diff --git a/.github/eslint.config.js b/.github/eslint.config.js index d3c33d8d947d..85ab9868ef40 100644 --- a/.github/eslint.config.js +++ b/.github/eslint.config.js @@ -1,5 +1,8 @@ -import pluginJs from "@eslint/js"; +import eslint from "@eslint/js"; import globals from "globals"; +import tseslint from "typescript-eslint"; /** @type {import('eslint').Linter.Config[]} */ -export default [{ languageOptions: { globals: globals.node } }, pluginJs.configs.recommended]; +export default tseslint.config(eslint.configs.recommended, tseslint.configs.recommended, { + languageOptions: { globals: globals.node }, +}); diff --git a/.github/package-lock.json b/.github/package-lock.json index 7bb869931463..f7d36cf703b0 100644 --- a/.github/package-lock.json +++ b/.github/package-lock.json @@ -30,6 +30,7 @@ "prettier-plugin-organize-imports": "^4.2.0", "semver": "^7.7.1", "typescript": "~5.8.2", + "typescript-eslint": "^8.38.0", "vitest": "^3.0.7" } }, @@ -186,9 +187,9 @@ } }, "node_modules/@babel/types": { - "version": "7.28.1", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.28.1.tgz", - "integrity": "sha512-x0LvFTekgSX+83TI28Y9wYPUfzrnl2aT5+5QLnO6v7mSJYtEEevuDRN0F0uSHRk1G1IWZC43o00Y0xDDrpBGPQ==", + "version": "7.28.2", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.28.2.tgz", + "integrity": "sha512-ruv7Ae4J5dUYULmeXw1gmb7rYRz57OWCPM57pHojnLq/3Z1CK2lNSLTCVjxVk1F/TZHwOZZrOWi0ur95BbLxNQ==", "dev": true, "license": "MIT", "dependencies": { @@ -210,9 +211,9 @@ } }, "node_modules/@esbuild/aix-ppc64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.6.tgz", - "integrity": "sha512-ShbM/3XxwuxjFiuVBHA+d3j5dyac0aEVVq1oluIDf71hUw0aRF59dV/efUsIwFnR6m8JNM2FjZOzmaZ8yG61kw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.8.tgz", + "integrity": "sha512-urAvrUedIqEiFR3FYSLTWQgLu5tb+m0qZw0NBEasUeo6wuqatkMDaRT+1uABiGXEu5vqgPd7FGE1BhsAIy9QVA==", "cpu": [ "ppc64" ], @@ -227,9 +228,9 @@ } }, "node_modules/@esbuild/android-arm": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.25.6.tgz", - "integrity": "sha512-S8ToEOVfg++AU/bHwdksHNnyLyVM+eMVAOf6yRKFitnwnbwwPNqKr3srzFRe7nzV69RQKb5DgchIX5pt3L53xg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.25.8.tgz", + "integrity": "sha512-RONsAvGCz5oWyePVnLdZY/HHwA++nxYWIX1atInlaW6SEkwq6XkP3+cb825EUcRs5Vss/lGh/2YxAb5xqc07Uw==", "cpu": [ "arm" ], @@ -244,9 +245,9 @@ } }, "node_modules/@esbuild/android-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.25.6.tgz", - "integrity": "sha512-hd5zdUarsK6strW+3Wxi5qWws+rJhCCbMiC9QZyzoxfk5uHRIE8T287giQxzVpEvCwuJ9Qjg6bEjcRJcgfLqoA==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.25.8.tgz", + "integrity": "sha512-OD3p7LYzWpLhZEyATcTSJ67qB5D+20vbtr6vHlHWSQYhKtzUYrETuWThmzFpZtFsBIxRvhO07+UgVA9m0i/O1w==", "cpu": [ "arm64" ], @@ -261,9 +262,9 @@ } }, "node_modules/@esbuild/android-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.25.6.tgz", - "integrity": "sha512-0Z7KpHSr3VBIO9A/1wcT3NTy7EB4oNC4upJ5ye3R7taCc2GUdeynSLArnon5G8scPwaU866d3H4BCrE5xLW25A==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.25.8.tgz", + "integrity": "sha512-yJAVPklM5+4+9dTeKwHOaA+LQkmrKFX96BM0A/2zQrbS6ENCmxc4OVoBs5dPkCCak2roAD+jKCdnmOqKszPkjA==", "cpu": [ "x64" ], @@ -278,9 +279,9 @@ } }, "node_modules/@esbuild/darwin-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.25.6.tgz", - "integrity": "sha512-FFCssz3XBavjxcFxKsGy2DYK5VSvJqa6y5HXljKzhRZ87LvEi13brPrf/wdyl/BbpbMKJNOr1Sd0jtW4Ge1pAA==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.25.8.tgz", + "integrity": "sha512-Jw0mxgIaYX6R8ODrdkLLPwBqHTtYHJSmzzd+QeytSugzQ0Vg4c5rDky5VgkoowbZQahCbsv1rT1KW72MPIkevw==", "cpu": [ "arm64" ], @@ -295,9 +296,9 @@ } }, "node_modules/@esbuild/darwin-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.25.6.tgz", - "integrity": "sha512-GfXs5kry/TkGM2vKqK2oyiLFygJRqKVhawu3+DOCk7OxLy/6jYkWXhlHwOoTb0WqGnWGAS7sooxbZowy+pK9Yg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.25.8.tgz", + "integrity": "sha512-Vh2gLxxHnuoQ+GjPNvDSDRpoBCUzY4Pu0kBqMBDlK4fuWbKgGtmDIeEC081xi26PPjn+1tct+Bh8FjyLlw1Zlg==", "cpu": [ "x64" ], @@ -312,9 +313,9 @@ } }, "node_modules/@esbuild/freebsd-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.25.6.tgz", - "integrity": "sha512-aoLF2c3OvDn2XDTRvn8hN6DRzVVpDlj2B/F66clWd/FHLiHaG3aVZjxQX2DYphA5y/evbdGvC6Us13tvyt4pWg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.25.8.tgz", + "integrity": "sha512-YPJ7hDQ9DnNe5vxOm6jaie9QsTwcKedPvizTVlqWG9GBSq+BuyWEDazlGaDTC5NGU4QJd666V0yqCBL2oWKPfA==", "cpu": [ "arm64" ], @@ -329,9 +330,9 @@ } }, "node_modules/@esbuild/freebsd-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.25.6.tgz", - "integrity": "sha512-2SkqTjTSo2dYi/jzFbU9Plt1vk0+nNg8YC8rOXXea+iA3hfNJWebKYPs3xnOUf9+ZWhKAaxnQNUf2X9LOpeiMQ==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.25.8.tgz", + "integrity": "sha512-MmaEXxQRdXNFsRN/KcIimLnSJrk2r5H8v+WVafRWz5xdSVmWLoITZQXcgehI2ZE6gioE6HirAEToM/RvFBeuhw==", "cpu": [ "x64" ], @@ -346,9 +347,9 @@ } }, "node_modules/@esbuild/linux-arm": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.25.6.tgz", - "integrity": "sha512-SZHQlzvqv4Du5PrKE2faN0qlbsaW/3QQfUUc6yO2EjFcA83xnwm91UbEEVx4ApZ9Z5oG8Bxz4qPE+HFwtVcfyw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.25.8.tgz", + "integrity": "sha512-FuzEP9BixzZohl1kLf76KEVOsxtIBFwCaLupVuk4eFVnOZfU+Wsn+x5Ryam7nILV2pkq2TqQM9EZPsOBuMC+kg==", "cpu": [ "arm" ], @@ -363,9 +364,9 @@ } }, "node_modules/@esbuild/linux-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.25.6.tgz", - "integrity": "sha512-b967hU0gqKd9Drsh/UuAm21Khpoh6mPBSgz8mKRq4P5mVK8bpA+hQzmm/ZwGVULSNBzKdZPQBRT3+WuVavcWsQ==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.25.8.tgz", + "integrity": "sha512-WIgg00ARWv/uYLU7lsuDK00d/hHSfES5BzdWAdAig1ioV5kaFNrtK8EqGcUBJhYqotlUByUKz5Qo6u8tt7iD/w==", "cpu": [ "arm64" ], @@ -380,9 +381,9 @@ } }, "node_modules/@esbuild/linux-ia32": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.25.6.tgz", - "integrity": "sha512-aHWdQ2AAltRkLPOsKdi3xv0mZ8fUGPdlKEjIEhxCPm5yKEThcUjHpWB1idN74lfXGnZ5SULQSgtr5Qos5B0bPw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.25.8.tgz", + "integrity": "sha512-A1D9YzRX1i+1AJZuFFUMP1E9fMaYY+GnSQil9Tlw05utlE86EKTUA7RjwHDkEitmLYiFsRd9HwKBPEftNdBfjg==", "cpu": [ "ia32" ], @@ -397,9 +398,9 @@ } }, "node_modules/@esbuild/linux-loong64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.25.6.tgz", - "integrity": "sha512-VgKCsHdXRSQ7E1+QXGdRPlQ/e08bN6WMQb27/TMfV+vPjjTImuT9PmLXupRlC90S1JeNNW5lzkAEO/McKeJ2yg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.25.8.tgz", + "integrity": "sha512-O7k1J/dwHkY1RMVvglFHl1HzutGEFFZ3kNiDMSOyUrB7WcoHGf96Sh+64nTRT26l3GMbCW01Ekh/ThKM5iI7hQ==", "cpu": [ "loong64" ], @@ -414,9 +415,9 @@ } }, "node_modules/@esbuild/linux-mips64el": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.25.6.tgz", - "integrity": "sha512-WViNlpivRKT9/py3kCmkHnn44GkGXVdXfdc4drNmRl15zVQ2+D2uFwdlGh6IuK5AAnGTo2qPB1Djppj+t78rzw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.25.8.tgz", + "integrity": "sha512-uv+dqfRazte3BzfMp8PAQXmdGHQt2oC/y2ovwpTteqrMx2lwaksiFZ/bdkXJC19ttTvNXBuWH53zy/aTj1FgGw==", "cpu": [ "mips64el" ], @@ -431,9 +432,9 @@ } }, "node_modules/@esbuild/linux-ppc64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.25.6.tgz", - "integrity": "sha512-wyYKZ9NTdmAMb5730I38lBqVu6cKl4ZfYXIs31Baf8aoOtB4xSGi3THmDYt4BTFHk7/EcVixkOV2uZfwU3Q2Jw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.25.8.tgz", + "integrity": "sha512-GyG0KcMi1GBavP5JgAkkstMGyMholMDybAf8wF5A70CALlDM2p/f7YFE7H92eDeH/VBtFJA5MT4nRPDGg4JuzQ==", "cpu": [ "ppc64" ], @@ -448,9 +449,9 @@ } }, "node_modules/@esbuild/linux-riscv64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.25.6.tgz", - "integrity": "sha512-KZh7bAGGcrinEj4qzilJ4hqTY3Dg2U82c8bv+e1xqNqZCrCyc+TL9AUEn5WGKDzm3CfC5RODE/qc96OcbIe33w==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.25.8.tgz", + "integrity": "sha512-rAqDYFv3yzMrq7GIcen3XP7TUEG/4LK86LUPMIz6RT8A6pRIDn0sDcvjudVZBiiTcZCY9y2SgYX2lgK3AF+1eg==", "cpu": [ "riscv64" ], @@ -465,9 +466,9 @@ } }, "node_modules/@esbuild/linux-s390x": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.25.6.tgz", - "integrity": "sha512-9N1LsTwAuE9oj6lHMyyAM+ucxGiVnEqUdp4v7IaMmrwb06ZTEVCIs3oPPplVsnjPfyjmxwHxHMF8b6vzUVAUGw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.25.8.tgz", + "integrity": "sha512-Xutvh6VjlbcHpsIIbwY8GVRbwoviWT19tFhgdA7DlenLGC/mbc3lBoVb7jxj9Z+eyGqvcnSyIltYUrkKzWqSvg==", "cpu": [ "s390x" ], @@ -482,9 +483,9 @@ } }, "node_modules/@esbuild/linux-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.6.tgz", - "integrity": "sha512-A6bJB41b4lKFWRKNrWoP2LHsjVzNiaurf7wyj/XtFNTsnPuxwEBWHLty+ZE0dWBKuSK1fvKgrKaNjBS7qbFKig==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.8.tgz", + "integrity": "sha512-ASFQhgY4ElXh3nDcOMTkQero4b1lgubskNlhIfJrsH5OKZXDpUAKBlNS0Kx81jwOBp+HCeZqmoJuihTv57/jvQ==", "cpu": [ "x64" ], @@ -499,9 +500,9 @@ } }, "node_modules/@esbuild/netbsd-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.25.6.tgz", - "integrity": "sha512-IjA+DcwoVpjEvyxZddDqBY+uJ2Snc6duLpjmkXm/v4xuS3H+3FkLZlDm9ZsAbF9rsfP3zeA0/ArNDORZgrxR/Q==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.25.8.tgz", + "integrity": "sha512-d1KfruIeohqAi6SA+gENMuObDbEjn22olAR7egqnkCD9DGBG0wsEARotkLgXDu6c4ncgWTZJtN5vcgxzWRMzcw==", "cpu": [ "arm64" ], @@ -516,9 +517,9 @@ } }, "node_modules/@esbuild/netbsd-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.25.6.tgz", - "integrity": "sha512-dUXuZr5WenIDlMHdMkvDc1FAu4xdWixTCRgP7RQLBOkkGgwuuzaGSYcOpW4jFxzpzL1ejb8yF620UxAqnBrR9g==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.25.8.tgz", + "integrity": "sha512-nVDCkrvx2ua+XQNyfrujIG38+YGyuy2Ru9kKVNyh5jAys6n+l44tTtToqHjino2My8VAY6Lw9H7RI73XFi66Cg==", "cpu": [ "x64" ], @@ -533,9 +534,9 @@ } }, "node_modules/@esbuild/openbsd-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.25.6.tgz", - "integrity": "sha512-l8ZCvXP0tbTJ3iaqdNf3pjaOSd5ex/e6/omLIQCVBLmHTlfXW3zAxQ4fnDmPLOB1x9xrcSi/xtCWFwCZRIaEwg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.25.8.tgz", + "integrity": "sha512-j8HgrDuSJFAujkivSMSfPQSAa5Fxbvk4rgNAS5i3K+r8s1X0p1uOO2Hl2xNsGFppOeHOLAVgYwDVlmxhq5h+SQ==", "cpu": [ "arm64" ], @@ -550,9 +551,9 @@ } }, "node_modules/@esbuild/openbsd-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.25.6.tgz", - "integrity": "sha512-hKrmDa0aOFOr71KQ/19JC7az1P0GWtCN1t2ahYAf4O007DHZt/dW8ym5+CUdJhQ/qkZmI1HAF8KkJbEFtCL7gw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.25.8.tgz", + "integrity": "sha512-1h8MUAwa0VhNCDp6Af0HToI2TJFAn1uqT9Al6DJVzdIBAd21m/G0Yfc77KDM3uF3T/YaOgQq3qTJHPbTOInaIQ==", "cpu": [ "x64" ], @@ -567,9 +568,9 @@ } }, "node_modules/@esbuild/openharmony-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.25.6.tgz", - "integrity": "sha512-+SqBcAWoB1fYKmpWoQP4pGtx+pUUC//RNYhFdbcSA16617cchuryuhOCRpPsjCblKukAckWsV+aQ3UKT/RMPcA==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.25.8.tgz", + "integrity": "sha512-r2nVa5SIK9tSWd0kJd9HCffnDHKchTGikb//9c7HX+r+wHYCpQrSgxhlY6KWV1nFo1l4KFbsMlHk+L6fekLsUg==", "cpu": [ "arm64" ], @@ -584,9 +585,9 @@ } }, "node_modules/@esbuild/sunos-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.25.6.tgz", - "integrity": "sha512-dyCGxv1/Br7MiSC42qinGL8KkG4kX0pEsdb0+TKhmJZgCUDBGmyo1/ArCjNGiOLiIAgdbWgmWgib4HoCi5t7kA==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.25.8.tgz", + "integrity": "sha512-zUlaP2S12YhQ2UzUfcCuMDHQFJyKABkAjvO5YSndMiIkMimPmxA+BYSBikWgsRpvyxuRnow4nS5NPnf9fpv41w==", "cpu": [ "x64" ], @@ -601,9 +602,9 @@ } }, "node_modules/@esbuild/win32-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.25.6.tgz", - "integrity": "sha512-42QOgcZeZOvXfsCBJF5Afw73t4veOId//XD3i+/9gSkhSV6Gk3VPlWncctI+JcOyERv85FUo7RxuxGy+z8A43Q==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.25.8.tgz", + "integrity": "sha512-YEGFFWESlPva8hGL+zvj2z/SaK+pH0SwOM0Nc/d+rVnW7GSTFlLBGzZkuSU9kFIGIo8q9X3ucpZhu8PDN5A2sQ==", "cpu": [ "arm64" ], @@ -618,9 +619,9 @@ } }, "node_modules/@esbuild/win32-ia32": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.25.6.tgz", - "integrity": "sha512-4AWhgXmDuYN7rJI6ORB+uU9DHLq/erBbuMoAuB4VWJTu5KtCgcKYPynF0YI1VkBNuEfjNlLrFr9KZPJzrtLkrQ==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.25.8.tgz", + "integrity": "sha512-hiGgGC6KZ5LZz58OL/+qVVoZiuZlUYlYHNAmczOm7bs2oE1XriPFi5ZHHrS8ACpV5EjySrnoCKmcbQMN+ojnHg==", "cpu": [ "ia32" ], @@ -635,9 +636,9 @@ } }, "node_modules/@esbuild/win32-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.25.6.tgz", - "integrity": "sha512-NgJPHHbEpLQgDH2MjQu90pzW/5vvXIZ7KOnPyNBm92A6WgZ/7b6fJyUBjoumLqeOQQGqY2QjQxRo97ah4Sj0cA==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.25.8.tgz", + "integrity": "sha512-cn3Yr7+OaaZq1c+2pe+8yxC8E144SReCQjN6/2ynubzYjvyqZjTXfQJpAcQpsdJq3My7XADANiYGHoFC69pLQw==", "cpu": [ "x64" ], @@ -792,9 +793,9 @@ } }, "node_modules/@eslint/plugin-kit": { - "version": "0.3.3", - "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.3.3.tgz", - "integrity": "sha512-1+WqvgNMhmlAambTvT3KPtCl/Ibr68VldY2XY40SL1CE0ZXiakFR/cbTspaF5HsnpDMvcYYoJHfl4980NBjGag==", + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.3.4.tgz", + "integrity": "sha512-Ul5l+lHEcw3L5+k8POx6r74mxEYKG5kOb6Xpy2gCRW6zweT6TEhAf8vhxGgjhqrd/VO/Dirhsb+1hNpD1ue9hw==", "dev": true, "license": "Apache-2.0", "dependencies": { @@ -963,6 +964,44 @@ "integrity": "sha512-GaHYm+c0O9MjZRu0ongGBRbinu8gVAMd2UZjji6jVmqKtZluZnptXGWhz1E8j8D2HJ3f/yMxKAUC0b+57wncIw==", "license": "MIT" }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, "node_modules/@octokit/auth-token": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-4.0.0.tgz", @@ -1706,15 +1745,273 @@ "license": "MIT" }, "node_modules/@types/node": { - "version": "20.19.8", - "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.8.tgz", - "integrity": "sha512-HzbgCY53T6bfu4tT7Aq3TvViJyHjLjPNaAS3HOuMc9pw97KHsUtXNX4L+wu59g1WnjsZSko35MbEqnO58rihhw==", + "version": "20.19.9", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.9.tgz", + "integrity": "sha512-cuVNgarYWZqxRJDQHEB58GEONhOK79QVR/qYx4S7kcUObQvUwvFnYxJuuHUKm2aieN9X3yZB4LZsuYNU1Qphsw==", "dev": true, "license": "MIT", "dependencies": { "undici-types": "~6.21.0" } }, + "node_modules/@typescript-eslint/eslint-plugin": { + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.38.0.tgz", + "integrity": "sha512-CPoznzpuAnIOl4nhj4tRr4gIPj5AfKgkiJmGQDaq+fQnRJTYlcBjbX3wbciGmpoPf8DREufuPRe1tNMZnGdanA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@eslint-community/regexpp": "^4.10.0", + "@typescript-eslint/scope-manager": "8.38.0", + "@typescript-eslint/type-utils": "8.38.0", + "@typescript-eslint/utils": "8.38.0", + "@typescript-eslint/visitor-keys": "8.38.0", + "graphemer": "^1.4.0", + "ignore": "^7.0.0", + "natural-compare": "^1.4.0", + "ts-api-utils": "^2.1.0" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "@typescript-eslint/parser": "^8.38.0", + "eslint": "^8.57.0 || ^9.0.0", + "typescript": ">=4.8.4 <5.9.0" + } + }, + "node_modules/@typescript-eslint/eslint-plugin/node_modules/ignore": { + "version": "7.0.5", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-7.0.5.tgz", + "integrity": "sha512-Hs59xBNfUIunMFgWAbGX5cq6893IbWg4KnrjbYwX3tx0ztorVgTDA6B2sxf8ejHJ4wz8BqGUMYlnzNBer5NvGg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 4" + } + }, + "node_modules/@typescript-eslint/parser": { + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.38.0.tgz", + "integrity": "sha512-Zhy8HCvBUEfBECzIl1PKqF4p11+d0aUJS1GeUiuqK9WmOug8YCmC4h4bjyBvMyAMI9sbRczmrYL5lKg/YMbrcQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typescript-eslint/scope-manager": "8.38.0", + "@typescript-eslint/types": "8.38.0", + "@typescript-eslint/typescript-estree": "8.38.0", + "@typescript-eslint/visitor-keys": "8.38.0", + "debug": "^4.3.4" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^8.57.0 || ^9.0.0", + "typescript": ">=4.8.4 <5.9.0" + } + }, + "node_modules/@typescript-eslint/project-service": { + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/project-service/-/project-service-8.38.0.tgz", + "integrity": "sha512-dbK7Jvqcb8c9QfH01YB6pORpqX1mn5gDZc9n63Ak/+jD67oWXn3Gs0M6vddAN+eDXBCS5EmNWzbSxsn9SzFWWg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typescript-eslint/tsconfig-utils": "^8.38.0", + "@typescript-eslint/types": "^8.38.0", + "debug": "^4.3.4" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "typescript": ">=4.8.4 <5.9.0" + } + }, + "node_modules/@typescript-eslint/scope-manager": { + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.38.0.tgz", + "integrity": "sha512-WJw3AVlFFcdT9Ri1xs/lg8LwDqgekWXWhH3iAF+1ZM+QPd7oxQ6jvtW/JPwzAScxitILUIFs0/AnQ/UWHzbATQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typescript-eslint/types": "8.38.0", + "@typescript-eslint/visitor-keys": "8.38.0" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/tsconfig-utils": { + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.38.0.tgz", + "integrity": "sha512-Lum9RtSE3EroKk/bYns+sPOodqb2Fv50XOl/gMviMKNvanETUuUcC9ObRbzrJ4VSd2JalPqgSAavwrPiPvnAiQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "typescript": ">=4.8.4 <5.9.0" + } + }, + "node_modules/@typescript-eslint/type-utils": { + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.38.0.tgz", + "integrity": "sha512-c7jAvGEZVf0ao2z+nnz8BUaHZD09Agbh+DY7qvBQqLiz8uJzRgVPj5YvOh8I8uEiH8oIUGIfHzMwUcGVco/SJg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typescript-eslint/types": "8.38.0", + "@typescript-eslint/typescript-estree": "8.38.0", + "@typescript-eslint/utils": "8.38.0", + "debug": "^4.3.4", + "ts-api-utils": "^2.1.0" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^8.57.0 || ^9.0.0", + "typescript": ">=4.8.4 <5.9.0" + } + }, + "node_modules/@typescript-eslint/types": { + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.38.0.tgz", + "integrity": "sha512-wzkUfX3plUqij4YwWaJyqhiPE5UCRVlFpKn1oCRn2O1bJ592XxWJj8ROQ3JD5MYXLORW84063z3tZTb/cs4Tyw==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/typescript-estree": { + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.38.0.tgz", + "integrity": "sha512-fooELKcAKzxux6fA6pxOflpNS0jc+nOQEEOipXFNjSlBS6fqrJOVY/whSn70SScHrcJ2LDsxWrneFoWYSVfqhQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typescript-eslint/project-service": "8.38.0", + "@typescript-eslint/tsconfig-utils": "8.38.0", + "@typescript-eslint/types": "8.38.0", + "@typescript-eslint/visitor-keys": "8.38.0", + "debug": "^4.3.4", + "fast-glob": "^3.3.2", + "is-glob": "^4.0.3", + "minimatch": "^9.0.4", + "semver": "^7.6.0", + "ts-api-utils": "^2.1.0" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "typescript": ">=4.8.4 <5.9.0" + } + }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/brace-expansion": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", + "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/minimatch": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", + "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "dev": true, + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/@typescript-eslint/utils": { + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.38.0.tgz", + "integrity": "sha512-hHcMA86Hgt+ijJlrD8fX0j1j8w4C92zue/8LOPAFioIno+W0+L7KqE8QZKCcPGc/92Vs9x36w/4MPTJhqXdyvg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@eslint-community/eslint-utils": "^4.7.0", + "@typescript-eslint/scope-manager": "8.38.0", + "@typescript-eslint/types": "8.38.0", + "@typescript-eslint/typescript-estree": "8.38.0" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^8.57.0 || ^9.0.0", + "typescript": ">=4.8.4 <5.9.0" + } + }, + "node_modules/@typescript-eslint/visitor-keys": { + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.38.0.tgz", + "integrity": "sha512-pWrTcoFNWuwHlA9CvlfSsGWs14JxfN1TH25zM5L7o0pRLhsoZkDnTsXfQRJBEWJoV5DL0jf+Z+sxiud+K0mq1g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typescript-eslint/types": "8.38.0", + "eslint-visitor-keys": "^4.2.1" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, "node_modules/@vitest/coverage-v8": { "version": "3.2.4", "resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-3.2.4.tgz", @@ -1993,6 +2290,19 @@ "concat-map": "0.0.1" } }, + "node_modules/braces": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "dev": true, + "license": "MIT", + "dependencies": { + "fill-range": "^7.1.1" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/cac": { "version": "6.7.14", "resolved": "https://registry.npmjs.org/cac/-/cac-6.7.14.tgz", @@ -2181,9 +2491,9 @@ "license": "MIT" }, "node_modules/esbuild": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.6.tgz", - "integrity": "sha512-GVuzuUwtdsghE3ocJ9Bs8PNoF13HNQ5TXbEi2AhvVb8xU1Iwt9Fos9FEamfoee+u/TOsn7GUWc04lz46n2bbTg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.8.tgz", + "integrity": "sha512-vVC0USHGtMi8+R4Kz8rt6JhEWLxsv9Rnu/lGYbPR8u47B+DCBksq9JarW0zOO7bs37hyOK1l2/oqtbciutL5+Q==", "dev": true, "hasInstallScript": true, "license": "MIT", @@ -2194,32 +2504,32 @@ "node": ">=18" }, "optionalDependencies": { - "@esbuild/aix-ppc64": "0.25.6", - "@esbuild/android-arm": "0.25.6", - "@esbuild/android-arm64": "0.25.6", - "@esbuild/android-x64": "0.25.6", - "@esbuild/darwin-arm64": "0.25.6", - "@esbuild/darwin-x64": "0.25.6", - "@esbuild/freebsd-arm64": "0.25.6", - "@esbuild/freebsd-x64": "0.25.6", - "@esbuild/linux-arm": "0.25.6", - "@esbuild/linux-arm64": "0.25.6", - "@esbuild/linux-ia32": "0.25.6", - "@esbuild/linux-loong64": "0.25.6", - "@esbuild/linux-mips64el": "0.25.6", - "@esbuild/linux-ppc64": "0.25.6", - "@esbuild/linux-riscv64": "0.25.6", - "@esbuild/linux-s390x": "0.25.6", - "@esbuild/linux-x64": "0.25.6", - "@esbuild/netbsd-arm64": "0.25.6", - "@esbuild/netbsd-x64": "0.25.6", - "@esbuild/openbsd-arm64": "0.25.6", - "@esbuild/openbsd-x64": "0.25.6", - "@esbuild/openharmony-arm64": "0.25.6", - "@esbuild/sunos-x64": "0.25.6", - "@esbuild/win32-arm64": "0.25.6", - "@esbuild/win32-ia32": "0.25.6", - "@esbuild/win32-x64": "0.25.6" + "@esbuild/aix-ppc64": "0.25.8", + "@esbuild/android-arm": "0.25.8", + "@esbuild/android-arm64": "0.25.8", + "@esbuild/android-x64": "0.25.8", + "@esbuild/darwin-arm64": "0.25.8", + "@esbuild/darwin-x64": "0.25.8", + "@esbuild/freebsd-arm64": "0.25.8", + "@esbuild/freebsd-x64": "0.25.8", + "@esbuild/linux-arm": "0.25.8", + "@esbuild/linux-arm64": "0.25.8", + "@esbuild/linux-ia32": "0.25.8", + "@esbuild/linux-loong64": "0.25.8", + "@esbuild/linux-mips64el": "0.25.8", + "@esbuild/linux-ppc64": "0.25.8", + "@esbuild/linux-riscv64": "0.25.8", + "@esbuild/linux-s390x": "0.25.8", + "@esbuild/linux-x64": "0.25.8", + "@esbuild/netbsd-arm64": "0.25.8", + "@esbuild/netbsd-x64": "0.25.8", + "@esbuild/openbsd-arm64": "0.25.8", + "@esbuild/openbsd-x64": "0.25.8", + "@esbuild/openharmony-arm64": "0.25.8", + "@esbuild/sunos-x64": "0.25.8", + "@esbuild/win32-arm64": "0.25.8", + "@esbuild/win32-ia32": "0.25.8", + "@esbuild/win32-x64": "0.25.8" } }, "node_modules/escape-string-regexp": { @@ -2434,6 +2744,36 @@ "dev": true, "license": "MIT" }, + "node_modules/fast-glob": { + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz", + "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.8" + }, + "engines": { + "node": ">=8.6.0" + } + }, + "node_modules/fast-glob/node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "dev": true, + "license": "ISC", + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, "node_modules/fast-json-stable-stringify": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", @@ -2448,19 +2788,14 @@ "dev": true, "license": "MIT" }, - "node_modules/fdir": { - "version": "6.4.6", - "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.4.6.tgz", - "integrity": "sha512-hiFoqpyZcfNm1yc4u8oWCf9A2c4D3QjCrks3zmoVKVxpQRzmPNar1hUJcBG2RQHvEVGDN+Jm81ZheVLAQMK6+w==", + "node_modules/fastq": { + "version": "1.19.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.19.1.tgz", + "integrity": "sha512-GwLTyxkCXjXbxqIhTsMI2Nui8huMPtnxg7krajPJAjnEG/iiOS7i+zCtWGZR9G0NBKbXKh6X9m9UIsYX/N6vvQ==", "dev": true, - "license": "MIT", - "peerDependencies": { - "picomatch": "^3 || ^4" - }, - "peerDependenciesMeta": { - "picomatch": { - "optional": true - } + "license": "ISC", + "dependencies": { + "reusify": "^1.0.4" } }, "node_modules/file-entry-cache": { @@ -2476,6 +2811,19 @@ "node": ">=16.0.0" } }, + "node_modules/fill-range": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "dev": true, + "license": "MIT", + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/find-up": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", @@ -2619,6 +2967,13 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/graphemer": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/graphemer/-/graphemer-1.4.0.tgz", + "integrity": "sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==", + "dev": true, + "license": "MIT" + }, "node_modules/has-flag": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", @@ -2706,6 +3061,16 @@ "node": ">=0.10.0" } }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.12.0" + } + }, "node_modules/isexe": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", @@ -2871,9 +3236,9 @@ "license": "MIT" }, "node_modules/loupe": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.1.4.tgz", - "integrity": "sha512-wJzkKwJrheKtknCOKNEtDK4iqg/MxmZheEMtSTYvnzRdEYaZzmgH976nenp8WdJRdx5Vc1X/9MO0Oszl6ezeXg==", + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.2.0.tgz", + "integrity": "sha512-2NCfZcT5VGVNX9mSZIxLRkEAegDGBpuQZBy13desuHeVORmBDyAET4TkJr4SjqQy3A8JDofMN6LpkK8Xcm/dlw==", "dev": true, "license": "MIT" }, @@ -2944,6 +3309,30 @@ "node": ">= 20" } }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/micromatch": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", + "dev": true, + "license": "MIT", + "dependencies": { + "braces": "^3.0.3", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, "node_modules/minimatch": { "version": "3.1.2", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", @@ -3141,13 +3530,13 @@ "license": "ISC" }, "node_modules/picomatch": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", - "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", "dev": true, "license": "MIT", "engines": { - "node": ">=12" + "node": ">=8.6" }, "funding": { "url": "https://github.com/sponsors/jonschlinkert" @@ -3235,6 +3624,27 @@ "node": ">=6" } }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, "node_modules/resolve-from": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", @@ -3245,6 +3655,17 @@ "node": ">=4" } }, + "node_modules/reusify": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.1.0.tgz", + "integrity": "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw==", + "dev": true, + "license": "MIT", + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, "node_modules/rollup": { "version": "4.45.1", "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.45.1.tgz", @@ -3285,6 +3706,30 @@ "fsevents": "~2.3.2" } }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, "node_modules/semver": { "version": "7.7.2", "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.2.tgz", @@ -3595,6 +4040,34 @@ "url": "https://github.com/sponsors/SuperchupuDev" } }, + "node_modules/tinyglobby/node_modules/fdir": { + "version": "6.4.6", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.4.6.tgz", + "integrity": "sha512-hiFoqpyZcfNm1yc4u8oWCf9A2c4D3QjCrks3zmoVKVxpQRzmPNar1hUJcBG2RQHvEVGDN+Jm81ZheVLAQMK6+w==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/tinyglobby/node_modules/picomatch": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", + "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, "node_modules/tinypool": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.1.1.tgz", @@ -3625,6 +4098,32 @@ "node": ">=14.0.0" } }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/ts-api-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.1.0.tgz", + "integrity": "sha512-CUgTZL1irw8u29bzrOD/nH85jqyc74D6SshFgujOIA7osm2Rz7dYH77agkx7H4FBNxDq7Cjf+IjaX/8zwFW+ZQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18.12" + }, + "peerDependencies": { + "typescript": ">=4.8.4" + } + }, "node_modules/tunnel": { "version": "0.0.6", "resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.6.tgz", @@ -3662,6 +4161,30 @@ "node": ">=14.17" } }, + "node_modules/typescript-eslint": { + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/typescript-eslint/-/typescript-eslint-8.38.0.tgz", + "integrity": "sha512-FsZlrYK6bPDGoLeZRuvx2v6qrM03I0U0SnfCLPs/XCCPCFD80xU9Pg09H/K+XFa68uJuZo7l/Xhs+eDRg2l3hg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typescript-eslint/eslint-plugin": "8.38.0", + "@typescript-eslint/parser": "8.38.0", + "@typescript-eslint/typescript-estree": "8.38.0", + "@typescript-eslint/utils": "8.38.0" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^8.57.0 || ^9.0.0", + "typescript": ">=4.8.4 <5.9.0" + } + }, "node_modules/undici": { "version": "5.29.0", "resolved": "https://registry.npmjs.org/undici/-/undici-5.29.0.tgz", @@ -3700,15 +4223,15 @@ } }, "node_modules/vite": { - "version": "7.0.4", - "resolved": "https://registry.npmjs.org/vite/-/vite-7.0.4.tgz", - "integrity": "sha512-SkaSguuS7nnmV7mfJ8l81JGBFV7Gvzp8IzgE8A8t23+AxuNX61Q5H1Tpz5efduSN7NHC8nQXD3sKQKZAu5mNEA==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/vite/-/vite-7.0.6.tgz", + "integrity": "sha512-MHFiOENNBd+Bd9uvc8GEsIzdkn1JxMmEeYX35tI3fv0sJBUTfW5tQsoaOwuY4KhBI09A3dUJ/DXf2yxPVPUceg==", "dev": true, "license": "MIT", "dependencies": { "esbuild": "^0.25.0", "fdir": "^6.4.6", - "picomatch": "^4.0.2", + "picomatch": "^4.0.3", "postcss": "^8.5.6", "rollup": "^4.40.0", "tinyglobby": "^0.2.14" @@ -3797,6 +4320,34 @@ "url": "https://opencollective.com/vitest" } }, + "node_modules/vite/node_modules/fdir": { + "version": "6.4.6", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.4.6.tgz", + "integrity": "sha512-hiFoqpyZcfNm1yc4u8oWCf9A2c4D3QjCrks3zmoVKVxpQRzmPNar1hUJcBG2RQHvEVGDN+Jm81ZheVLAQMK6+w==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/vite/node_modules/picomatch": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", + "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, "node_modules/vitest": { "version": "3.2.4", "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.2.4.tgz", @@ -3870,6 +4421,19 @@ } } }, + "node_modules/vitest/node_modules/picomatch": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", + "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, "node_modules/which": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", @@ -4029,9 +4593,9 @@ } }, "node_modules/zod": { - "version": "4.0.5", - "resolved": "https://registry.npmjs.org/zod/-/zod-4.0.5.tgz", - "integrity": "sha512-/5UuuRPStvHXu7RS+gmvRf4NXrNxpSllGwDnCBcJZtQsKrviYXm54yDGV2KYNLT5kq0lHGcl7lqWJLgSaG+tgA==", + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/zod/-/zod-4.0.8.tgz", + "integrity": "sha512-+MSh9cZU9r3QKlHqrgHMTSr3QwMGv4PLfR0M4N/sYWV5/x67HgXEhIGObdBkpnX8G78pTgWnIrBL2lZcNJOtfg==", "license": "MIT", "funding": { "url": "https://github.com/sponsors/colinhacks" diff --git a/.github/package.json b/.github/package.json index 3b60a515de83..65cb98057057 100644 --- a/.github/package.json +++ b/.github/package.json @@ -31,6 +31,7 @@ "prettier-plugin-organize-imports": "^4.2.0", "semver": "^7.7.1", "typescript": "~5.8.2", + "typescript-eslint": "^8.38.0", "vitest": "^3.0.7" }, "scripts": { diff --git a/.github/shared/cmd/api-doc-preview.js b/.github/shared/cmd/api-doc-preview.js new file mode 100755 index 000000000000..d3ba8a05a372 --- /dev/null +++ b/.github/shared/cmd/api-doc-preview.js @@ -0,0 +1,137 @@ +#!/usr/bin/env node +// @ts-check + +import { mkdir, writeFile } from "fs/promises"; +import { dirname, join, resolve } from "path"; +import { fileURLToPath } from "url"; +import { parseArgs } from "util"; + +import { getChangedFilesStatuses, swagger } from "../src/changed-files.js"; + +import { + getSwaggersToProcess, + indexMd, + mappingJSONTemplate, + repoJSONTemplate, +} from "../src/doc-preview.js"; + +const __dirname = dirname(fileURLToPath(import.meta.url)); + +function usage() { + console.log(`Usage: +npx api-doc-preview --output + +parameters: + --output Directory to write documentation artifacts to. + --build-id Build ID, used in the documentation index. Defaults to BUILD_BUILDID environment variable. + --spec-repo-name Name of the repository containing the swagger files of the form /. Defaults to BUILD_REPOSITORY_NAME environment variable. + --spec-repo-pr-number PR number of the repository containing the swagger files. Defaults to SYSTEM_PULLREQUEST_PULLREQUESTNUMBER environment variable. + --spec-repo-root Root path of the repository containing the swagger files. Defaults to the root of the repository containing this script.`); +} + +const { + values: { + output: outputDir, + "build-id": buildId, + "spec-repo-name": specRepoName, + "spec-repo-pr-number": specRepoPrNumber, + "spec-repo-root": specRepoRoot, + }, +} = parseArgs({ + options: { + output: { type: "string", default: "" }, + "build-id": { + type: "string", + default: process.env.BUILD_BUILDID || "", + }, + "spec-repo-name": { + type: "string", + default: process.env.BUILD_REPOSITORY_NAME || "", + }, + "spec-repo-pr-number": { + type: "string", + default: process.env.SYSTEM_PULLREQUEST_PULLREQUESTNUMBER || "", + }, + "spec-repo-root": { + type: "string", + default: resolve(__dirname, "../../../"), + }, + }, + allowPositionals: false, +}); + +let validArgs = true; + +if (!outputDir) { + console.log(`Missing required parameter --output. Value given: ${outputDir || ""}`); + validArgs = false; +} + +if (!specRepoName) { + console.log( + `Missing required parameter --spec-repo-name. Value given: ${specRepoName || ""}`, + ); + validArgs = false; +} + +if (!specRepoPrNumber) { + console.log( + `Missing required parameter --spec-repo-pr-number. Value given: ${specRepoPrNumber || ""}`, + ); + validArgs = false; +} + +if (!specRepoRoot) { + console.log(`Invalid parameter --spec-repo-root. Value given: ${specRepoRoot || ""}`); + validArgs = false; +} + +if (!validArgs) { + usage(); + process.exit(1); +} + +// Get selected version and swaggers to process + +const changedFileStatuses = await getChangedFilesStatuses({ + cwd: specRepoRoot, + paths: ["specification"], +}); + +// Exclude deleted files as they are not relevant for generating documentation. +const changedFiles = [ + ...changedFileStatuses.additions, + ...changedFileStatuses.modifications, + // Current names of renamed files are interesting, previous names are not. + ...changedFileStatuses.renames.map((r) => r.to), +]; +console.log(`Found ${changedFiles.length} relevant changed files in ${specRepoRoot}`); +console.log("Changed files:"); +changedFiles.forEach((file) => console.log(` - ${file}`)); +const swaggerPaths = changedFiles.filter(swagger); + +if (swaggerPaths.length === 0) { + console.log("No eligible swagger files found. No documentation artifacts will be written."); + process.exit(0); +} + +const { selectedVersion, swaggersToProcess } = getSwaggersToProcess(swaggerPaths); + +const repoName = specRepoName; +const prNumber = specRepoPrNumber; + +await mkdir(outputDir, { recursive: true }); +await writeFile( + join(outputDir, "repo.json"), + JSON.stringify(repoJSONTemplate(repoName, prNumber), null, 2), +); +await writeFile( + join(outputDir, "mapping.json"), + JSON.stringify(mappingJSONTemplate(swaggersToProcess), null, 2), +); +await writeFile(join(outputDir, "index.md"), indexMd(buildId, repoName, prNumber)); +console.log(`Documentation preview artifacts written to ${outputDir}`); + +console.log(`Doc preview for API version ${selectedVersion} includes:`); +swaggersToProcess.forEach((swagger) => console.log(` - ${swagger}`)); +console.log(`Artifacts written to: ${outputDir}`); diff --git a/.github/shared/package-lock.json b/.github/shared/package-lock.json index 308e5e1b9ad2..9cbc1f0f1c22 100644 --- a/.github/shared/package-lock.json +++ b/.github/shared/package-lock.json @@ -13,6 +13,7 @@ "simple-git": "^3.27.0" }, "bin": { + "api-doc-preview": "cmd/api-doc-preview.js", "spec-model": "cmd/spec-model.js" }, "devDependencies": { @@ -99,9 +100,9 @@ } }, "node_modules/@babel/types": { - "version": "7.28.1", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.28.1.tgz", - "integrity": "sha512-x0LvFTekgSX+83TI28Y9wYPUfzrnl2aT5+5QLnO6v7mSJYtEEevuDRN0F0uSHRk1G1IWZC43o00Y0xDDrpBGPQ==", + "version": "7.28.2", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.28.2.tgz", + "integrity": "sha512-ruv7Ae4J5dUYULmeXw1gmb7rYRz57OWCPM57pHojnLq/3Z1CK2lNSLTCVjxVk1F/TZHwOZZrOWi0ur95BbLxNQ==", "dev": true, "license": "MIT", "dependencies": { @@ -123,9 +124,9 @@ } }, "node_modules/@esbuild/aix-ppc64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.6.tgz", - "integrity": "sha512-ShbM/3XxwuxjFiuVBHA+d3j5dyac0aEVVq1oluIDf71hUw0aRF59dV/efUsIwFnR6m8JNM2FjZOzmaZ8yG61kw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.8.tgz", + "integrity": "sha512-urAvrUedIqEiFR3FYSLTWQgLu5tb+m0qZw0NBEasUeo6wuqatkMDaRT+1uABiGXEu5vqgPd7FGE1BhsAIy9QVA==", "cpu": [ "ppc64" ], @@ -140,9 +141,9 @@ } }, "node_modules/@esbuild/android-arm": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.25.6.tgz", - "integrity": "sha512-S8ToEOVfg++AU/bHwdksHNnyLyVM+eMVAOf6yRKFitnwnbwwPNqKr3srzFRe7nzV69RQKb5DgchIX5pt3L53xg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.25.8.tgz", + "integrity": "sha512-RONsAvGCz5oWyePVnLdZY/HHwA++nxYWIX1atInlaW6SEkwq6XkP3+cb825EUcRs5Vss/lGh/2YxAb5xqc07Uw==", "cpu": [ "arm" ], @@ -157,9 +158,9 @@ } }, "node_modules/@esbuild/android-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.25.6.tgz", - "integrity": "sha512-hd5zdUarsK6strW+3Wxi5qWws+rJhCCbMiC9QZyzoxfk5uHRIE8T287giQxzVpEvCwuJ9Qjg6bEjcRJcgfLqoA==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.25.8.tgz", + "integrity": "sha512-OD3p7LYzWpLhZEyATcTSJ67qB5D+20vbtr6vHlHWSQYhKtzUYrETuWThmzFpZtFsBIxRvhO07+UgVA9m0i/O1w==", "cpu": [ "arm64" ], @@ -174,9 +175,9 @@ } }, "node_modules/@esbuild/android-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.25.6.tgz", - "integrity": "sha512-0Z7KpHSr3VBIO9A/1wcT3NTy7EB4oNC4upJ5ye3R7taCc2GUdeynSLArnon5G8scPwaU866d3H4BCrE5xLW25A==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.25.8.tgz", + "integrity": "sha512-yJAVPklM5+4+9dTeKwHOaA+LQkmrKFX96BM0A/2zQrbS6ENCmxc4OVoBs5dPkCCak2roAD+jKCdnmOqKszPkjA==", "cpu": [ "x64" ], @@ -191,9 +192,9 @@ } }, "node_modules/@esbuild/darwin-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.25.6.tgz", - "integrity": "sha512-FFCssz3XBavjxcFxKsGy2DYK5VSvJqa6y5HXljKzhRZ87LvEi13brPrf/wdyl/BbpbMKJNOr1Sd0jtW4Ge1pAA==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.25.8.tgz", + "integrity": "sha512-Jw0mxgIaYX6R8ODrdkLLPwBqHTtYHJSmzzd+QeytSugzQ0Vg4c5rDky5VgkoowbZQahCbsv1rT1KW72MPIkevw==", "cpu": [ "arm64" ], @@ -208,9 +209,9 @@ } }, "node_modules/@esbuild/darwin-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.25.6.tgz", - "integrity": "sha512-GfXs5kry/TkGM2vKqK2oyiLFygJRqKVhawu3+DOCk7OxLy/6jYkWXhlHwOoTb0WqGnWGAS7sooxbZowy+pK9Yg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.25.8.tgz", + "integrity": "sha512-Vh2gLxxHnuoQ+GjPNvDSDRpoBCUzY4Pu0kBqMBDlK4fuWbKgGtmDIeEC081xi26PPjn+1tct+Bh8FjyLlw1Zlg==", "cpu": [ "x64" ], @@ -225,9 +226,9 @@ } }, "node_modules/@esbuild/freebsd-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.25.6.tgz", - "integrity": "sha512-aoLF2c3OvDn2XDTRvn8hN6DRzVVpDlj2B/F66clWd/FHLiHaG3aVZjxQX2DYphA5y/evbdGvC6Us13tvyt4pWg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.25.8.tgz", + "integrity": "sha512-YPJ7hDQ9DnNe5vxOm6jaie9QsTwcKedPvizTVlqWG9GBSq+BuyWEDazlGaDTC5NGU4QJd666V0yqCBL2oWKPfA==", "cpu": [ "arm64" ], @@ -242,9 +243,9 @@ } }, "node_modules/@esbuild/freebsd-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.25.6.tgz", - "integrity": "sha512-2SkqTjTSo2dYi/jzFbU9Plt1vk0+nNg8YC8rOXXea+iA3hfNJWebKYPs3xnOUf9+ZWhKAaxnQNUf2X9LOpeiMQ==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.25.8.tgz", + "integrity": "sha512-MmaEXxQRdXNFsRN/KcIimLnSJrk2r5H8v+WVafRWz5xdSVmWLoITZQXcgehI2ZE6gioE6HirAEToM/RvFBeuhw==", "cpu": [ "x64" ], @@ -259,9 +260,9 @@ } }, "node_modules/@esbuild/linux-arm": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.25.6.tgz", - "integrity": "sha512-SZHQlzvqv4Du5PrKE2faN0qlbsaW/3QQfUUc6yO2EjFcA83xnwm91UbEEVx4ApZ9Z5oG8Bxz4qPE+HFwtVcfyw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.25.8.tgz", + "integrity": "sha512-FuzEP9BixzZohl1kLf76KEVOsxtIBFwCaLupVuk4eFVnOZfU+Wsn+x5Ryam7nILV2pkq2TqQM9EZPsOBuMC+kg==", "cpu": [ "arm" ], @@ -276,9 +277,9 @@ } }, "node_modules/@esbuild/linux-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.25.6.tgz", - "integrity": "sha512-b967hU0gqKd9Drsh/UuAm21Khpoh6mPBSgz8mKRq4P5mVK8bpA+hQzmm/ZwGVULSNBzKdZPQBRT3+WuVavcWsQ==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.25.8.tgz", + "integrity": "sha512-WIgg00ARWv/uYLU7lsuDK00d/hHSfES5BzdWAdAig1ioV5kaFNrtK8EqGcUBJhYqotlUByUKz5Qo6u8tt7iD/w==", "cpu": [ "arm64" ], @@ -293,9 +294,9 @@ } }, "node_modules/@esbuild/linux-ia32": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.25.6.tgz", - "integrity": "sha512-aHWdQ2AAltRkLPOsKdi3xv0mZ8fUGPdlKEjIEhxCPm5yKEThcUjHpWB1idN74lfXGnZ5SULQSgtr5Qos5B0bPw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.25.8.tgz", + "integrity": "sha512-A1D9YzRX1i+1AJZuFFUMP1E9fMaYY+GnSQil9Tlw05utlE86EKTUA7RjwHDkEitmLYiFsRd9HwKBPEftNdBfjg==", "cpu": [ "ia32" ], @@ -310,9 +311,9 @@ } }, "node_modules/@esbuild/linux-loong64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.25.6.tgz", - "integrity": "sha512-VgKCsHdXRSQ7E1+QXGdRPlQ/e08bN6WMQb27/TMfV+vPjjTImuT9PmLXupRlC90S1JeNNW5lzkAEO/McKeJ2yg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.25.8.tgz", + "integrity": "sha512-O7k1J/dwHkY1RMVvglFHl1HzutGEFFZ3kNiDMSOyUrB7WcoHGf96Sh+64nTRT26l3GMbCW01Ekh/ThKM5iI7hQ==", "cpu": [ "loong64" ], @@ -327,9 +328,9 @@ } }, "node_modules/@esbuild/linux-mips64el": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.25.6.tgz", - "integrity": "sha512-WViNlpivRKT9/py3kCmkHnn44GkGXVdXfdc4drNmRl15zVQ2+D2uFwdlGh6IuK5AAnGTo2qPB1Djppj+t78rzw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.25.8.tgz", + "integrity": "sha512-uv+dqfRazte3BzfMp8PAQXmdGHQt2oC/y2ovwpTteqrMx2lwaksiFZ/bdkXJC19ttTvNXBuWH53zy/aTj1FgGw==", "cpu": [ "mips64el" ], @@ -344,9 +345,9 @@ } }, "node_modules/@esbuild/linux-ppc64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.25.6.tgz", - "integrity": "sha512-wyYKZ9NTdmAMb5730I38lBqVu6cKl4ZfYXIs31Baf8aoOtB4xSGi3THmDYt4BTFHk7/EcVixkOV2uZfwU3Q2Jw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.25.8.tgz", + "integrity": "sha512-GyG0KcMi1GBavP5JgAkkstMGyMholMDybAf8wF5A70CALlDM2p/f7YFE7H92eDeH/VBtFJA5MT4nRPDGg4JuzQ==", "cpu": [ "ppc64" ], @@ -361,9 +362,9 @@ } }, "node_modules/@esbuild/linux-riscv64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.25.6.tgz", - "integrity": "sha512-KZh7bAGGcrinEj4qzilJ4hqTY3Dg2U82c8bv+e1xqNqZCrCyc+TL9AUEn5WGKDzm3CfC5RODE/qc96OcbIe33w==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.25.8.tgz", + "integrity": "sha512-rAqDYFv3yzMrq7GIcen3XP7TUEG/4LK86LUPMIz6RT8A6pRIDn0sDcvjudVZBiiTcZCY9y2SgYX2lgK3AF+1eg==", "cpu": [ "riscv64" ], @@ -378,9 +379,9 @@ } }, "node_modules/@esbuild/linux-s390x": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.25.6.tgz", - "integrity": "sha512-9N1LsTwAuE9oj6lHMyyAM+ucxGiVnEqUdp4v7IaMmrwb06ZTEVCIs3oPPplVsnjPfyjmxwHxHMF8b6vzUVAUGw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.25.8.tgz", + "integrity": "sha512-Xutvh6VjlbcHpsIIbwY8GVRbwoviWT19tFhgdA7DlenLGC/mbc3lBoVb7jxj9Z+eyGqvcnSyIltYUrkKzWqSvg==", "cpu": [ "s390x" ], @@ -395,9 +396,9 @@ } }, "node_modules/@esbuild/linux-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.6.tgz", - "integrity": "sha512-A6bJB41b4lKFWRKNrWoP2LHsjVzNiaurf7wyj/XtFNTsnPuxwEBWHLty+ZE0dWBKuSK1fvKgrKaNjBS7qbFKig==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.8.tgz", + "integrity": "sha512-ASFQhgY4ElXh3nDcOMTkQero4b1lgubskNlhIfJrsH5OKZXDpUAKBlNS0Kx81jwOBp+HCeZqmoJuihTv57/jvQ==", "cpu": [ "x64" ], @@ -412,9 +413,9 @@ } }, "node_modules/@esbuild/netbsd-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.25.6.tgz", - "integrity": "sha512-IjA+DcwoVpjEvyxZddDqBY+uJ2Snc6duLpjmkXm/v4xuS3H+3FkLZlDm9ZsAbF9rsfP3zeA0/ArNDORZgrxR/Q==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.25.8.tgz", + "integrity": "sha512-d1KfruIeohqAi6SA+gENMuObDbEjn22olAR7egqnkCD9DGBG0wsEARotkLgXDu6c4ncgWTZJtN5vcgxzWRMzcw==", "cpu": [ "arm64" ], @@ -429,9 +430,9 @@ } }, "node_modules/@esbuild/netbsd-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.25.6.tgz", - "integrity": "sha512-dUXuZr5WenIDlMHdMkvDc1FAu4xdWixTCRgP7RQLBOkkGgwuuzaGSYcOpW4jFxzpzL1ejb8yF620UxAqnBrR9g==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.25.8.tgz", + "integrity": "sha512-nVDCkrvx2ua+XQNyfrujIG38+YGyuy2Ru9kKVNyh5jAys6n+l44tTtToqHjino2My8VAY6Lw9H7RI73XFi66Cg==", "cpu": [ "x64" ], @@ -446,9 +447,9 @@ } }, "node_modules/@esbuild/openbsd-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.25.6.tgz", - "integrity": "sha512-l8ZCvXP0tbTJ3iaqdNf3pjaOSd5ex/e6/omLIQCVBLmHTlfXW3zAxQ4fnDmPLOB1x9xrcSi/xtCWFwCZRIaEwg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.25.8.tgz", + "integrity": "sha512-j8HgrDuSJFAujkivSMSfPQSAa5Fxbvk4rgNAS5i3K+r8s1X0p1uOO2Hl2xNsGFppOeHOLAVgYwDVlmxhq5h+SQ==", "cpu": [ "arm64" ], @@ -463,9 +464,9 @@ } }, "node_modules/@esbuild/openbsd-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.25.6.tgz", - "integrity": "sha512-hKrmDa0aOFOr71KQ/19JC7az1P0GWtCN1t2ahYAf4O007DHZt/dW8ym5+CUdJhQ/qkZmI1HAF8KkJbEFtCL7gw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.25.8.tgz", + "integrity": "sha512-1h8MUAwa0VhNCDp6Af0HToI2TJFAn1uqT9Al6DJVzdIBAd21m/G0Yfc77KDM3uF3T/YaOgQq3qTJHPbTOInaIQ==", "cpu": [ "x64" ], @@ -480,9 +481,9 @@ } }, "node_modules/@esbuild/openharmony-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.25.6.tgz", - "integrity": "sha512-+SqBcAWoB1fYKmpWoQP4pGtx+pUUC//RNYhFdbcSA16617cchuryuhOCRpPsjCblKukAckWsV+aQ3UKT/RMPcA==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.25.8.tgz", + "integrity": "sha512-r2nVa5SIK9tSWd0kJd9HCffnDHKchTGikb//9c7HX+r+wHYCpQrSgxhlY6KWV1nFo1l4KFbsMlHk+L6fekLsUg==", "cpu": [ "arm64" ], @@ -497,9 +498,9 @@ } }, "node_modules/@esbuild/sunos-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.25.6.tgz", - "integrity": "sha512-dyCGxv1/Br7MiSC42qinGL8KkG4kX0pEsdb0+TKhmJZgCUDBGmyo1/ArCjNGiOLiIAgdbWgmWgib4HoCi5t7kA==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.25.8.tgz", + "integrity": "sha512-zUlaP2S12YhQ2UzUfcCuMDHQFJyKABkAjvO5YSndMiIkMimPmxA+BYSBikWgsRpvyxuRnow4nS5NPnf9fpv41w==", "cpu": [ "x64" ], @@ -514,9 +515,9 @@ } }, "node_modules/@esbuild/win32-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.25.6.tgz", - "integrity": "sha512-42QOgcZeZOvXfsCBJF5Afw73t4veOId//XD3i+/9gSkhSV6Gk3VPlWncctI+JcOyERv85FUo7RxuxGy+z8A43Q==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.25.8.tgz", + "integrity": "sha512-YEGFFWESlPva8hGL+zvj2z/SaK+pH0SwOM0Nc/d+rVnW7GSTFlLBGzZkuSU9kFIGIo8q9X3ucpZhu8PDN5A2sQ==", "cpu": [ "arm64" ], @@ -531,9 +532,9 @@ } }, "node_modules/@esbuild/win32-ia32": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.25.6.tgz", - "integrity": "sha512-4AWhgXmDuYN7rJI6ORB+uU9DHLq/erBbuMoAuB4VWJTu5KtCgcKYPynF0YI1VkBNuEfjNlLrFr9KZPJzrtLkrQ==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.25.8.tgz", + "integrity": "sha512-hiGgGC6KZ5LZz58OL/+qVVoZiuZlUYlYHNAmczOm7bs2oE1XriPFi5ZHHrS8ACpV5EjySrnoCKmcbQMN+ojnHg==", "cpu": [ "ia32" ], @@ -548,9 +549,9 @@ } }, "node_modules/@esbuild/win32-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.25.6.tgz", - "integrity": "sha512-NgJPHHbEpLQgDH2MjQu90pzW/5vvXIZ7KOnPyNBm92A6WgZ/7b6fJyUBjoumLqeOQQGqY2QjQxRo97ah4Sj0cA==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.25.8.tgz", + "integrity": "sha512-cn3Yr7+OaaZq1c+2pe+8yxC8E144SReCQjN6/2ynubzYjvyqZjTXfQJpAcQpsdJq3My7XADANiYGHoFC69pLQw==", "cpu": [ "x64" ], @@ -705,9 +706,9 @@ } }, "node_modules/@eslint/plugin-kit": { - "version": "0.3.3", - "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.3.3.tgz", - "integrity": "sha512-1+WqvgNMhmlAambTvT3KPtCl/Ibr68VldY2XY40SL1CE0ZXiakFR/cbTspaF5HsnpDMvcYYoJHfl4980NBjGag==", + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.3.4.tgz", + "integrity": "sha512-Ul5l+lHEcw3L5+k8POx6r74mxEYKG5kOb6Xpy2gCRW6zweT6TEhAf8vhxGgjhqrd/VO/Dirhsb+1hNpD1ue9hw==", "dev": true, "license": "Apache-2.0", "dependencies": { @@ -1219,9 +1220,9 @@ "license": "MIT" }, "node_modules/@types/node": { - "version": "20.19.8", - "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.8.tgz", - "integrity": "sha512-HzbgCY53T6bfu4tT7Aq3TvViJyHjLjPNaAS3HOuMc9pw97KHsUtXNX4L+wu59g1WnjsZSko35MbEqnO58rihhw==", + "version": "20.19.9", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.9.tgz", + "integrity": "sha512-cuVNgarYWZqxRJDQHEB58GEONhOK79QVR/qYx4S7kcUObQvUwvFnYxJuuHUKm2aieN9X3yZB4LZsuYNU1Qphsw==", "dev": true, "license": "MIT", "dependencies": { @@ -1673,9 +1674,9 @@ "license": "MIT" }, "node_modules/esbuild": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.6.tgz", - "integrity": "sha512-GVuzuUwtdsghE3ocJ9Bs8PNoF13HNQ5TXbEi2AhvVb8xU1Iwt9Fos9FEamfoee+u/TOsn7GUWc04lz46n2bbTg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.8.tgz", + "integrity": "sha512-vVC0USHGtMi8+R4Kz8rt6JhEWLxsv9Rnu/lGYbPR8u47B+DCBksq9JarW0zOO7bs37hyOK1l2/oqtbciutL5+Q==", "dev": true, "hasInstallScript": true, "license": "MIT", @@ -1686,32 +1687,32 @@ "node": ">=18" }, "optionalDependencies": { - "@esbuild/aix-ppc64": "0.25.6", - "@esbuild/android-arm": "0.25.6", - "@esbuild/android-arm64": "0.25.6", - "@esbuild/android-x64": "0.25.6", - "@esbuild/darwin-arm64": "0.25.6", - "@esbuild/darwin-x64": "0.25.6", - "@esbuild/freebsd-arm64": "0.25.6", - "@esbuild/freebsd-x64": "0.25.6", - "@esbuild/linux-arm": "0.25.6", - "@esbuild/linux-arm64": "0.25.6", - "@esbuild/linux-ia32": "0.25.6", - "@esbuild/linux-loong64": "0.25.6", - "@esbuild/linux-mips64el": "0.25.6", - "@esbuild/linux-ppc64": "0.25.6", - "@esbuild/linux-riscv64": "0.25.6", - "@esbuild/linux-s390x": "0.25.6", - "@esbuild/linux-x64": "0.25.6", - "@esbuild/netbsd-arm64": "0.25.6", - "@esbuild/netbsd-x64": "0.25.6", - "@esbuild/openbsd-arm64": "0.25.6", - "@esbuild/openbsd-x64": "0.25.6", - "@esbuild/openharmony-arm64": "0.25.6", - "@esbuild/sunos-x64": "0.25.6", - "@esbuild/win32-arm64": "0.25.6", - "@esbuild/win32-ia32": "0.25.6", - "@esbuild/win32-x64": "0.25.6" + "@esbuild/aix-ppc64": "0.25.8", + "@esbuild/android-arm": "0.25.8", + "@esbuild/android-arm64": "0.25.8", + "@esbuild/android-x64": "0.25.8", + "@esbuild/darwin-arm64": "0.25.8", + "@esbuild/darwin-x64": "0.25.8", + "@esbuild/freebsd-arm64": "0.25.8", + "@esbuild/freebsd-x64": "0.25.8", + "@esbuild/linux-arm": "0.25.8", + "@esbuild/linux-arm64": "0.25.8", + "@esbuild/linux-ia32": "0.25.8", + "@esbuild/linux-loong64": "0.25.8", + "@esbuild/linux-mips64el": "0.25.8", + "@esbuild/linux-ppc64": "0.25.8", + "@esbuild/linux-riscv64": "0.25.8", + "@esbuild/linux-s390x": "0.25.8", + "@esbuild/linux-x64": "0.25.8", + "@esbuild/netbsd-arm64": "0.25.8", + "@esbuild/netbsd-x64": "0.25.8", + "@esbuild/openbsd-arm64": "0.25.8", + "@esbuild/openbsd-x64": "0.25.8", + "@esbuild/openharmony-arm64": "0.25.8", + "@esbuild/sunos-x64": "0.25.8", + "@esbuild/win32-arm64": "0.25.8", + "@esbuild/win32-ia32": "0.25.8", + "@esbuild/win32-x64": "0.25.8" } }, "node_modules/escape-string-regexp": { @@ -2346,9 +2347,9 @@ "license": "MIT" }, "node_modules/loupe": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.1.4.tgz", - "integrity": "sha512-wJzkKwJrheKtknCOKNEtDK4iqg/MxmZheEMtSTYvnzRdEYaZzmgH976nenp8WdJRdx5Vc1X/9MO0Oszl6ezeXg==", + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.2.0.tgz", + "integrity": "sha512-2NCfZcT5VGVNX9mSZIxLRkEAegDGBpuQZBy13desuHeVORmBDyAET4TkJr4SjqQy3A8JDofMN6LpkK8Xcm/dlw==", "dev": true, "license": "MIT" }, @@ -3125,15 +3126,15 @@ } }, "node_modules/vite": { - "version": "7.0.4", - "resolved": "https://registry.npmjs.org/vite/-/vite-7.0.4.tgz", - "integrity": "sha512-SkaSguuS7nnmV7mfJ8l81JGBFV7Gvzp8IzgE8A8t23+AxuNX61Q5H1Tpz5efduSN7NHC8nQXD3sKQKZAu5mNEA==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/vite/-/vite-7.0.6.tgz", + "integrity": "sha512-MHFiOENNBd+Bd9uvc8GEsIzdkn1JxMmEeYX35tI3fv0sJBUTfW5tQsoaOwuY4KhBI09A3dUJ/DXf2yxPVPUceg==", "dev": true, "license": "MIT", "dependencies": { "esbuild": "^0.25.0", "fdir": "^6.4.6", - "picomatch": "^4.0.2", + "picomatch": "^4.0.3", "postcss": "^8.5.6", "rollup": "^4.40.0", "tinyglobby": "^0.2.14" diff --git a/.github/shared/package.json b/.github/shared/package.json index 52f96ba59d1a..b82abb44c7aa 100644 --- a/.github/shared/package.json +++ b/.github/shared/package.json @@ -23,7 +23,8 @@ "./test/examples": "./test/examples.js" }, "bin": { - "spec-model": "./cmd/spec-model.js" + "spec-model": "./cmd/spec-model.js", + "api-doc-preview": "./cmd/api-doc-preview.js" }, "_comments": { "dependencies": "Runtime dependencies must be kept to an absolute minimum for performance, ideally with no transitive dependencies", diff --git a/.github/shared/src/changed-files.js b/.github/shared/src/changed-files.js index 5641a95e64ed..4561c394116f 100644 --- a/.github/shared/src/changed-files.js +++ b/.github/shared/src/changed-files.js @@ -8,6 +8,8 @@ import { includesFolder } from "./path.js"; debug.enable("simple-git"); /** + * Get a list of changed files in a git repository + * * @param {Object} [options] * @param {string} [options.baseCommitish] Default: "HEAD^". * @param {string} [options.cwd] Current working directory. Default: process.cwd(). @@ -32,7 +34,6 @@ export async function getChangedFiles(options = {}) { const result = await simpleGit(cwd).diff(["--name-only", baseCommitish, headCommitish, ...paths]); const files = result.trim().split("\n"); - logger?.info("Changed Files:"); for (const file of files) { logger?.info(` ${file}`); @@ -43,6 +44,10 @@ export async function getChangedFiles(options = {}) { } /** + * Get a list of changed files in a git repository with statuses for additions, + * modifications, deletions, and renames. Warning: rename behavior can vary + * based on the git client's configuration of diff.renames. + * * @param {Object} [options] * @param {string} [options.baseCommitish] Default: "HEAD^". * @param {string} [options.cwd] Current working directory. Default: process.cwd(). @@ -210,6 +215,14 @@ export function typespec(file) { ); } +/** + * @param {string} [file] + * @returns {boolean} + */ +export function quickstartTemplate(file) { + return typeof file === "string" && json(file) && file.includes("/quickstart-templates/"); +} + /** * @param {string} [file] * @returns {boolean} @@ -220,6 +233,7 @@ export function swagger(file) { json(file) && (dataPlane(file) || resourceManager(file)) && !example(file) && + !quickstartTemplate(file) && !scenario(file) ); } diff --git a/.github/shared/src/doc-preview.js b/.github/shared/src/doc-preview.js new file mode 100644 index 000000000000..1ac67eb7ee36 --- /dev/null +++ b/.github/shared/src/doc-preview.js @@ -0,0 +1,167 @@ +// @ts-check +const DOCS_NAMESPACE = "_swagger_specs"; +const SPEC_FILE_REGEX = + "(specification/)+(.*)/(resourcemanager|resource-manager|dataplane|data-plane|control-plane)/(.*)/(preview|stable|privatepreview)/(.*?)/(example)?(.*)"; + +/** + * @typedef {Object} SwaggerFileMetadata + * @property {string} path + * @property {string} serviceName + * @property {string} serviceType + * @property {string} resourceProvider + * @property {string} releaseState + * @property {string} apiVersion + * @property {string} fileName + */ + +/** + * @typedef {Object} RepoJSONTemplate + * @property {Object[]} repo + * @property {string} repo[].url + * @property {string} repo[].prNumber + * @property {string} repo[].name + */ + +/** + * @typedef {Object} MappingJSONStructure + * @property {string} target_api_root_dir + * @property {boolean} enable_markdown_fragment + * @property {string} markdown_fragment_folder + * @property {boolean} use_yaml_toc + * @property {boolean} formalize_url + * @property {string[]} version_list + * @property {Object[]} organizations + * @property {string} organizations[].index + * @property {string} organizations[].default_toc_title + * @property {string} organizations[].version + * @property {Object[]} organizations[].services + * @property {string} organizations[].services[].toc_title + * @property {string} organizations[].services[].url_group + * @property {Object[]} organizations[].services[].swagger_files + * @property {string} organizations[].services[].swagger_files[].source + */ + +/** + * Extract swagger file metadata from path. + * @param {string} specPath + * @returns {SwaggerFileMetadata} + */ +export function parseSwaggerFilePath(specPath) { + const m = specPath.match(SPEC_FILE_REGEX); + if (!m) { + throw new Error(`Path "${specPath}" does not match expected swagger file pattern.`); + } + const [path, , serviceName, serviceType, resourceProvider, releaseState, apiVersion, , fileName] = + m; + return { + path, + serviceName, + serviceType, + resourceProvider, + releaseState, + apiVersion, + fileName, + }; +} + +/** + * @param {string} repoName + * @param {string} prNumber + * @returns {object} + */ +export function repoJSONTemplate(repoName, prNumber) { + return { + repo: [ + { + url: `https://github.com/${repoName}`, + prNumber: prNumber, + name: DOCS_NAMESPACE, + }, + ], + }; +} + +/** + * @param {string[]} files + * @returns {MappingJSONStructure} + */ +export function mappingJSONTemplate(files) { + return { + target_api_root_dir: "structured", + enable_markdown_fragment: true, + markdown_fragment_folder: "authored", + use_yaml_toc: true, + formalize_url: true, + version_list: ["default"], + organizations: [ + { + index: "index.md", + default_toc_title: "Getting Started", + version: "default", + services: [ + { + toc_title: "Documentation Preview", + url_group: "documentation-preview", + swagger_files: files.map((source) => ({ + source: `${DOCS_NAMESPACE}/${source}`, + })), + }, + ], + }, + ], + }; +} + +/** + * @param {string} buildId + * @param {string} repoName + * @param {string} prNumber + * @returns {string} + */ +export function indexMd(buildId, repoName, prNumber) { + return `# Documentation Preview for swagger pipeline build #${buildId} + +Welcome to documentation preview for ${repoName}/pull/${prNumber} +created via the swagger pipeline. + +Your documentation may be viewed in the menu on the left hand side. + +If you have issues around documentation generation, please feel free to contact +us in the [Docs Support Teams Channel](https://aka.ms/ci-fix/api-docs-help)`; +} + +/** + * Given a list of changed swagger files, select an API version and a list of + * swagger files in that API version to process. + * @param {string[]} swaggerFiles + **/ +export function getSwaggersToProcess(swaggerFiles) { + const swaggerFileObjs = swaggerFiles.map(parseSwaggerFilePath); + + const versions = swaggerFileObjs.map((obj) => obj.apiVersion).filter(Boolean); + if (versions.length === 0) { + throw new Error("No new API versions found in eligible swagger files."); + } + const uniqueVersions = Array.from(new Set(versions)); + + let selectedVersion; + if (uniqueVersions.length === 1) { + selectedVersion = uniqueVersions[0]; + console.log(`Single API version found: ${selectedVersion}`); + } else { + // This sorting logic is ported from the original code which sorts only the + // strings and doesn't attempt to parse versions for more semantically-aware + // sorting. + const sortedVersions = [...uniqueVersions].sort(); + selectedVersion = sortedVersions[sortedVersions.length - 1]; + console.log( + `Multiple API versions found: ${JSON.stringify(sortedVersions)}. Selected version: ${selectedVersion}`, + ); + } + + const swaggersToProcess = swaggerFileObjs + .filter((obj) => obj.apiVersion === selectedVersion) + .map((obj) => obj.path); + + return { selectedVersion, swaggersToProcess }; +} diff --git a/.github/shared/src/spec-model.js b/.github/shared/src/spec-model.js index bed65aee13b6..9d3281f951dd 100644 --- a/.github/shared/src/spec-model.js +++ b/.github/shared/src/spec-model.js @@ -20,7 +20,7 @@ const specModelCache = new Map(); export class SpecModel { /** @type {string} absolute path */ - // @ts-ignore Ignore error that value may not be set in ctor (since we may returned cached value) + // @ts-expect-error Ignore error that value may not be set in ctor (since we may returned cached value) #folder; /** @type {import('./logger.js').ILogger | undefined} */ diff --git a/.github/shared/test/changed-files.test.js b/.github/shared/test/changed-files.test.js index 92bd84b827db..e98dadff5d9d 100644 --- a/.github/shared/test/changed-files.test.js +++ b/.github/shared/test/changed-files.test.js @@ -16,6 +16,7 @@ import { getChangedFiles, getChangedFilesStatuses, json, + quickstartTemplate, readme, resourceManager, scenario, @@ -62,6 +63,7 @@ describe("changedFiles", () => { "specification/contosowidgetmanager/resource-manager/Microsoft.Contoso/stable/2021-11-01/contoso.json", "specification/contosowidgetmanager/resource-manager/Microsoft.Contoso/stable/2021-11-01/examples/Employees_Get.json", "specification/contosowidgetmanager/Contoso.Management/scenarios/2021-11-01/Employees_Get.json", + "specification/compute/quickstart-templates/swagger.json", ]; const filesResolved = files.map((f) => resolve(f)); @@ -77,6 +79,7 @@ describe("changedFiles", () => { "specification/contosowidgetmanager/resource-manager/Microsoft.Contoso/stable/2021-11-01/contoso.json", "specification/contosowidgetmanager/resource-manager/Microsoft.Contoso/stable/2021-11-01/examples/Employees_Get.json", "specification/contosowidgetmanager/Contoso.Management/scenarios/2021-11-01/Employees_Get.json", + "specification/compute/quickstart-templates/swagger.json", ]; expect(files.filter(json)).toEqual(expected); @@ -140,6 +143,12 @@ describe("changedFiles", () => { expect(filesResolved.filter(example)).toEqual(expected.map((f) => resolve(f))); }); + it("filter:quickstartTemplate", () => { + const expected = ["specification/compute/quickstart-templates/swagger.json"]; + + expect(files.filter(quickstartTemplate)).toEqual(expected); + }); + it("filter:scenarios", () => { const expected = [ "not-spec/contosowidgetmanager/Contoso.Management/scenarios/2021-11-01/Employees_Get.json", diff --git a/.github/shared/test/doc-preview.test.js b/.github/shared/test/doc-preview.test.js new file mode 100644 index 000000000000..b0425c4f8b36 --- /dev/null +++ b/.github/shared/test/doc-preview.test.js @@ -0,0 +1,140 @@ +// @ts-check + +import { describe, expect, test } from "vitest"; +import { + getSwaggersToProcess, + indexMd, + mappingJSONTemplate, + parseSwaggerFilePath, + repoJSONTemplate, +} from "../src/doc-preview.js"; + +describe("parseSwaggerFilePath", () => { + test("throws null when given invalid path", () => { + expect(() => parseSwaggerFilePath("invalid/path/to/swagger.json")).toThrow(); + }); + + test("parses valid swagger file path", () => { + const path = + "specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/BatchService.json"; + const result = parseSwaggerFilePath(path); + + expect(result).toEqual({ + path: path, + serviceName: "batch", + serviceType: "data-plane", + resourceProvider: "Azure.Batch", + releaseState: "preview", + apiVersion: "2024-07-01.20.0", + fileName: "BatchService.json", + }); + }); +}); + +describe("getSwaggersToProcess", () => { + test("throws when swagger paths do not properly parse", () => { + expect(() => getSwaggersToProcess(["specification/inscrutable/path/swagger.json"])).toThrow(); + }); + + test("returns swaggers to process for valid files", () => { + const files = [ + "specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/BatchService.json", + ]; + + const { selectedVersion, swaggersToProcess } = getSwaggersToProcess(files); + + expect(selectedVersion).toEqual("2024-07-01.20.0"); + expect(swaggersToProcess).toEqual(files); + }); + + test("selects the latest version from multiple files with multiple versions", () => { + const files = [ + "specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/BatchService.json", + "specification/batch/data-plane/Azure.Batch/preview/2025-06-01/BatchService.json", + ]; + + const { selectedVersion, swaggersToProcess } = getSwaggersToProcess(files); + + expect(selectedVersion).toEqual("2025-06-01"); + expect(swaggersToProcess).toEqual([files[1]]); + }); +}); + +describe("repoJSONTemplate", () => { + test("matches snapshot", () => { + const actual = repoJSONTemplate("test-repo", "1234"); + + expect(actual).toMatchInlineSnapshot(` + { + "repo": [ + { + "name": "_swagger_specs", + "prNumber": "1234", + "url": "https://github.com/test-repo", + }, + ], + } + `); + }); +}); + +describe("mappingJSONTemplate", () => { + test("matches snapshot", () => { + const swaggers = [ + "specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/BatchService.json", + ]; + const actual = mappingJSONTemplate(swaggers); + + expect(actual).toMatchInlineSnapshot(` + { + "enable_markdown_fragment": true, + "formalize_url": true, + "markdown_fragment_folder": "authored", + "organizations": [ + { + "default_toc_title": "Getting Started", + "index": "index.md", + "services": [ + { + "swagger_files": [ + { + "source": "_swagger_specs/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/BatchService.json", + }, + ], + "toc_title": "Documentation Preview", + "url_group": "documentation-preview", + }, + ], + "version": "default", + }, + ], + "target_api_root_dir": "structured", + "use_yaml_toc": true, + "version_list": [ + "default", + ], + } + `); + }); +}); + +describe("indexMd", () => { + test("matches snapshot", () => { + const buildId = "build-123"; + const repoName = "test-repo"; + const prNumber = "1234"; + const actual = indexMd(buildId, repoName, prNumber); + + expect(actual).toMatchInlineSnapshot(` + "# Documentation Preview for swagger pipeline build #build-123 + + Welcome to documentation preview for test-repo/pull/1234 + created via the swagger pipeline. + + Your documentation may be viewed in the menu on the left hand side. + + If you have issues around documentation generation, please feel free to contact + us in the [Docs Support Teams Channel](https://aka.ms/ci-fix/api-docs-help)" + `); + }); +}); diff --git a/.github/shared/test/equality.test.js b/.github/shared/test/equality.test.js index 1dbcc77b255a..b4ab178f4e6e 100644 --- a/.github/shared/test/equality.test.js +++ b/.github/shared/test/equality.test.js @@ -31,9 +31,9 @@ describe("equality", () => { [new Set([1, 2]), new Set([1, 2]), true], [new Set([1, 2, 3]), new Set([1, 2, 3]), true], ])("setEquals(%s, %s, %s)", (set1, set2, expected) => { - // @ts-ignore + // @ts-expect-error testing runtime behavior of invalid types expect(setEquals(set1, set2)).toBe(expected); - // @ts-ignore + // @ts-expect-error testing runtime behavior of invalid types expect(setEquals(set2, set1)).toBe(expected); }); }); diff --git a/.github/shared/test/spec-model.test.js b/.github/shared/test/spec-model.test.js index b4cdc81b112c..e159719055a9 100644 --- a/.github/shared/test/spec-model.test.js +++ b/.github/shared/test/spec-model.test.js @@ -117,7 +117,7 @@ describe("SpecModel", () => { const tag = globalConfig["tag"]; - // @ts-ignore + // @ts-expect-error testing runtime behavior of invalid types expect(tag).not.toBeTypeOf(Date); expect(tag).toBeTypeOf("string"); diff --git a/.github/workflows/src/context.js b/.github/workflows/src/context.js index 99e78b52eb56..aa3d7dbb4aa9 100644 --- a/.github/workflows/src/context.js +++ b/.github/workflows/src/context.js @@ -25,7 +25,9 @@ export async function extractInputs(github, context, core) { // Log full context when debug is enabled. Most workflows should be idempotent and can be re-run // with debug enabled to replay the previous context. - core.isDebug() && core.debug(`context: ${JSON.stringify(context)}`); + if (core.isDebug()) { + core.debug(`context: ${JSON.stringify(context)}`); + } /** @type {{ owner: string, repo: string, head_sha: string, issue_number: number, run_id: number, details_url?: string }} */ let inputs; diff --git a/.github/workflows/src/summarize-checks/summarize-checks.js b/.github/workflows/src/summarize-checks/summarize-checks.js index 4fe44b107958..c04829a20e65 100644 --- a/.github/workflows/src/summarize-checks/summarize-checks.js +++ b/.github/workflows/src/summarize-checks/summarize-checks.js @@ -283,6 +283,13 @@ export default async function summarizeChecks({ github, context, core }) { const targetBranch = context.payload.pull_request?.base?.ref; core.info(`PR target branch: ${targetBranch}`); + if (!issue_number) { + core.info( + "This summarize-checks was triggered off a workflow that doesn't provide the issue-number artifact, early exiting.", + ); + return; + } + await summarizeChecksImpl( github, context, @@ -319,7 +326,9 @@ export async function summarizeChecksImpl( event_name, targetBranch, ) { - core.info(`Handling ${event_name} event for PR #${issue_number} in ${owner}/${repo}.`); + core.info( + `Handling ${event_name} event for PR #${issue_number} in ${owner}/${repo}@${head_sha}.`, + ); // retrieve latest labels state const labels = await github.paginate(github.rest.issues.listLabelsOnIssue, { @@ -347,9 +356,9 @@ export async function summarizeChecksImpl( core.info( `Summarize checks label actions against ${owner}/${repo}#${issue_number}: \n` + - `The following labels were present: [${Array.from(labelContext.present).join(", ")}]` + - `Removing labels [${Array.from(labelContext.toRemove).join(", ")}] then \n` + - `Adding labels [${Array.from(labelContext.toAdd).join(", ")}]`, + `The following labels were present: [${Array.from(labelContext.present).join(", ")}] \n` + + `Removing labels: [${Array.from(labelContext.toRemove).join(", ")}] \n` + + `Adding labels: [${Array.from(labelContext.toAdd).join(", ")}]`, ); // for (const label of labelContext.toRemove) { diff --git a/.github/workflows/test/github.test.js b/.github/workflows/test/github.test.js index 9dfcef9dbd0a..3cc5770e4e60 100644 --- a/.github/workflows/test/github.test.js +++ b/.github/workflows/test/github.test.js @@ -191,7 +191,7 @@ describe("writeToActionsSummary function", () => { const result = await writeToActionsSummary("Test content", mockCore); // Verify result - expect(result).undefined; + expect(result).toBeUndefined(); // Verify summary methods were called expect(mockCore.summary.addRaw).toHaveBeenCalledWith("Test content"); diff --git a/.github/workflows/test/mocks.js b/.github/workflows/test/mocks.js index d6fdfafc66de..555bcb3d295a 100644 --- a/.github/workflows/test/mocks.js +++ b/.github/workflows/test/mocks.js @@ -53,7 +53,7 @@ export function createMockCore() { setOutput: vi.fn((name, value) => console.log(`setOutput('${name}', '${value}')`)), setFailed: vi.fn((msg) => console.log(`setFailed('${msg}')`)), summary: { - // eslint-disable-next-line no-unused-vars + // eslint-disable-next-line @typescript-eslint/no-unused-vars addRaw: vi.fn(function (content) { return this; // Return 'this' for method chaining }), diff --git a/.github/workflows/test/spec-gen-sdk-status.test.js b/.github/workflows/test/spec-gen-sdk-status.test.js index 1817f2e7c67b..6ac0ad303da9 100644 --- a/.github/workflows/test/spec-gen-sdk-status.test.js +++ b/.github/workflows/test/spec-gen-sdk-status.test.js @@ -1,4 +1,3 @@ -/* eslint-disable no-unused-vars */ // @ts-check import fs from "fs"; import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; @@ -22,6 +21,7 @@ describe("spec-gen-sdk-status", () => { // Setup specific mocks getAzurePipelineArtifactMock = vi .spyOn(artifacts, "getAzurePipelineArtifact") + // eslint-disable-next-line @typescript-eslint/no-unused-vars .mockImplementation(async ({ ado_build_id, ado_project_url, artifactName }) => { return { artifactData: JSON.stringify({ @@ -34,6 +34,7 @@ describe("spec-gen-sdk-status", () => { writeToActionsSummaryMock = vi .spyOn(github, "writeToActionsSummary") + // eslint-disable-next-line @typescript-eslint/no-unused-vars .mockImplementation(async (content, core) => { // Implementation that just returns return; diff --git a/eng/pipelines/swagger-api-doc-preview.yml b/eng/pipelines/swagger-api-doc-preview.yml new file mode 100644 index 000000000000..8174542fd87f --- /dev/null +++ b/eng/pipelines/swagger-api-doc-preview.yml @@ -0,0 +1,227 @@ +trigger: none +pr: + paths: + include: + # Trigger for files that will result in a doc preview build + - specification/** + + # Smoke test on changed files + - eng/pipelines/swagger-api-doc-preview.yml + - eng/pipelines/templates/steps/set-sha-check.yml + - .github/shared/src/doc-preview.js + - .github/shared/cmd/api-doc-preview.js + +jobs: + - job: SwaggerApiDocPreview + + pool: + name: $(LINUXPOOL) + vmImage: $(LINUXVMIMAGE) + + variables: + - template: /eng/pipelines/templates/variables/globals.yml + - template: /eng/pipelines/templates/variables/image.yml + + - name: BranchName + value: preview/$(Build.Repository.Name)/pr/$(System.PullRequest.PullRequestNumber)/build/$(Build.BuildId)/attempt/$(System.JobAttempt) + + - name: CurrentBuildUrl + value: $(System.CollectionUri)$(System.TeamProject)/_build/results?buildId=$(Build.BuildId) + + - name: StatusName + value: 'Swagger ApiDocPreview' + + steps: + - template: /eng/pipelines/templates/steps/set-sha-check.yml + parameters: + State: pending + TargetUrl: $(CurrentBuildUrl) + Description: 'Starting docs build' + Context: $(StatusName) + + - checkout: self + # Fetch depth required to get list of changed files + fetchDepth: 2 + + - template: /eng/common/pipelines/templates/steps/sparse-checkout.yml + parameters: + SkipCheckoutNone: true + TokenToUseForAuth: $(azuresdk-github-pat) + # Path does not need to be set because sparse-checkout.yml already + # checks out files in the repo root + Repositories: + - Name: MicrosoftDocs/AzureRestPreview + Commitish: main + WorkingDirectory: AzureRestPreview + + - template: /eng/pipelines/templates/steps/npm-install.yml + parameters: + WorkingDirectory: .github/shared + + - script: cmd/api-doc-preview.js --output ../../AzureRestPreview + displayName: Generate Swagger API documentation preview + workingDirectory: .github/shared + + - template: /eng/common/pipelines/templates/steps/git-push-changes.yml + parameters: + WorkingDirectory: AzureRestPreview + BaseRepoOwner: MicrosoftDocs + TargetRepoOwner: MicrosoftDocs + TargetRepoName: AzureRestPreview + BaseRepoBranch: $(BranchName) + CommitMsg: | + Update API Doc Preview + Build: $(System.CollectionUri)$(System.TeamProject)/_build/results?buildId=$(Build.BuildId) + PR: $(System.PullRequest.SourceRepositoryURI)/pull/$(System.PullRequest.PullRequestId) + + - task: AzureCLI@2 + displayName: Start docs build + condition: and(succeeded(), eq(variables['HasChanges'], 'true')) + inputs: + azureSubscription: msdocs-apidrop-connection + scriptType: pscore + scriptLocation: inlineScript + inlineScript: | + $buildStartRaw = az pipelines build queue ` + --organization "https://dev.azure.com/apidrop/" ` + --project "Content CI" ` + --definition-id "8157" ` + --variables 'params={"target_repo":{"url":"https://github.com/MicrosoftDocs/AzureRestPreview","branch":"$(BranchName)"}, "source_of_truth": "code"}' + $buildStartRaw | Set-Content buildstart.json + $buildStart = $buildStartRaw | ConvertFrom-Json + Write-Host "Build started at https://dev.azure.com/apidrop/Content%20CI/_build/results?buildId=$($buildStart.id)" + + - template: /eng/pipelines/templates/steps/set-sha-check.yml + parameters: + Condition: and(succeeded(), eq(variables['HasChanges'], 'true')) + State: pending + TargetUrl: $(CurrentBuildUrl) + Description: 'Waiting for docs build to finish' + Context: $(StatusName) + + - task: AzureCLI@2 + displayName: Wait for docs build to finish + condition: and(succeeded(), eq(variables['HasChanges'], 'true')) + # Retry on failure to handle transient issues or builds that run longer + # than the token used by az CLI is valid + retryCountOnTaskFailure: 3 + inputs: + azureSubscription: msdocs-apidrop-connection + scriptType: pscore + scriptLocation: inlineScript + inlineScript: | + $buildStart = Get-Content buildstart.json | ConvertFrom-Json + + Write-Host "Waiting for build to finish: https://dev.azure.com/apidrop/Content%20CI/_build/results?buildId=$($buildStart.id)" + + # Timeout in 10 minutes to avoid infinite waiting + $start = Get-Date + while (((Get-Date) - $start).TotalMinutes -lt 10) { + $runStatusRaw = az pipelines runs show ` + --organization "https://dev.azure.com/apidrop/" ` + --project "Content CI" ` + --id "$($buildStart.id)" + + if ($LASTEXITCODE) { + Write-Host "Failed to get run status" + Write-Host "Exit code: $LASTEXITCODE" + Write-Host "Output: $runStatusRaw" + exit 1 + } + + $runStatus = $runStatusRaw | ConvertFrom-Json + Write-Host "Run status: $($runStatus.status)" + + if ($runStatus.status -eq "completed") { + break; + } + Start-Sleep -Seconds 10 + } + + Write-Host "Build completed with status: $($runStatus.result)" + Write-Host "Build logs: https://dev.azure.com/apidrop/Content%20CI/_build/results?buildId=$($buildStart.id)" + + Write-Host "Downloading artifact..." + $artifactDownloadRaw = az pipelines runs artifact download ` + --organization "https://dev.azure.com/apidrop/" ` + --project "Content CI" ` + --run-id "$($buildStart.id)" ` + --artifact-name "report" ` + --path "./" + + if ($LASTEXITCODE) { + Write-Host "Failed to download artifact" + Write-Host "Exit code: $LASTEXITCODE" + Write-Host "Output: $artifactDownloadRaw" + exit 1 + } + + Write-Host "Artifact downloaded successfully" + + - pwsh: | + # Read the report.json file downloaded from the docs build artifact + $reportRaw = Get-Content -Path "./report.json" -Raw + $report = $reportRaw | ConvertFrom-Json -AsHashtable + + # Get build ID from buildstart.json (set during the "Start docs build" step) + $buildStart = Get-Content buildstart.json | ConvertFrom-Json + $buildLink = "https://dev.azure.com/apidrop/Content%20CI/_build/results?buildId=$($buildStart.id)" + + if ($report.status -ne "Succeeded") { + Write-Host "Docs build failed with status: $($report.status)" + Write-Host "Report:" + Write-Host $reportRaw + + Write-Host "##vso[task.setvariable variable=CheckUrl]${buildLink}" + Write-Host "##vso[task.setvariable variable=CheckDescription]Docs build failed (click to see pipeline logs)" + Write-Host "##vso[task.setvariable variable=CheckState]failure" + + # Docs build failed, but this job should not fail unless it + # encounters an unexpected error. The check status will be set in + # the next task. + exit 0 + } + + Write-Host "Docs build succeeded with status: $($report.status)" + + $docsPreviewUrl = "https://review.learn.microsoft.com/en-us/rest/api/azure-rest-preview/?branch=$([System.Web.HttpUtility]::UrlEncode($report.branch))&view=azure-rest-preview" + Write-Host "##vso[task.setvariable variable=CheckUrl]$docsPreviewUrl" + Write-Host "##vso[task.setvariable variable=CheckDescription]Docs build succeeded (click to see preview)" + Write-Host "##vso[task.setvariable variable=CheckState]success" + Write-Host "Docs preview URL: $docsPreviewUrl" + + exit 0 + displayName: Interpret docs build results + condition: and(succeeded(), eq(variables['HasChanges'], 'true')) + + # Sets check status from docs build using $(CheckUrl), $(CheckState), and + # $(CheckDescription) variables set by api-doc-preview-interpret.js. + - template: /eng/pipelines/templates/steps/set-sha-check.yml + parameters: + DisplayName: Set PR status from docs build + Condition: and(succeeded(), eq(variables['HasChanges'], 'true')) + State: $(CheckState) + TargetUrl: $(CheckUrl) + Description: $(CheckDescription) + Context: $(StatusName) + + - template: /eng/pipelines/templates/steps/set-sha-check.yml + parameters: + DisplayName: Set PR status for no-op + Condition: and(succeeded(), ne(variables['HasChanges'], 'true')) + State: success + TargetUrl: $(CurrentBuildUrl) + Description: No files changed require docs build + Context: $(StatusName) + + # In the event of a failure in this job (not the docs build job), set the + # PR status to failed and link to the current build. + - template: /eng/pipelines/templates/steps/set-sha-check.yml + parameters: + DisplayName: Set PR status for job failure + # Only run if a previous step in the job failed + Condition: failed() + State: failure + TargetUrl: $(CurrentBuildUrl) + Description: 'Orchestration build failed (click to see logs)' + Context: $(StatusName) diff --git a/eng/pipelines/templates/steps/npm-install.yml b/eng/pipelines/templates/steps/npm-install.yml index c64de780bc12..399d58b558fa 100644 --- a/eng/pipelines/templates/steps/npm-install.yml +++ b/eng/pipelines/templates/steps/npm-install.yml @@ -2,6 +2,9 @@ parameters: - name: NodeVersion type: string default: $(NodeVersion) + - name: WorkingDirectory + type: string + default: $(Build.SourcesDirectory) steps: - template: /eng/pipelines/templates/steps/use-node-version.yml @@ -10,7 +13,9 @@ steps: - script: npm ci displayName: npm ci + workingDirectory: ${{ parameters.WorkingDirectory }} - script: npm ls -a || true displayName: npm ls -a condition: succeededOrFailed() + workingDirectory: ${{ parameters.WorkingDirectory }} diff --git a/eng/pipelines/templates/steps/set-sha-check.yml b/eng/pipelines/templates/steps/set-sha-check.yml new file mode 100644 index 000000000000..ae5845922de0 --- /dev/null +++ b/eng/pipelines/templates/steps/set-sha-check.yml @@ -0,0 +1,64 @@ +# Create a "status" check for a SHA (inferred from PR by default) in a GitHub +# repository. By default this uses the azure-sdk account. This might not work +# for required checks where a source must be configured. + +parameters: + - name: Sha + type: string + default: $(System.PullRequest.SourceCommitId) + + - name: RepositoryName + type: string + default: $(Build.Repository.Name) + + - name: State + type: string + default: 'pending' + # Valid values: + # - error + # - failure + # - pending + # - success + + - name: TargetUrl + type: string + default: '' + + - name: Description + type: string + default: '' + + - name: Context + type: string + default: default context + + - name: Condition + type: string + default: succeeded() + + - name: DisplayName + type: string + default: 'Set PR status' + + - name: GitHubToken + type: string + default: $(azuresdk-github-pat) + +steps: + - bash: | + echo "Repository Name: ${{ parameters.RepositoryName }}" + echo "Commit ID: ${{ parameters.Sha }}" + echo "State: ${{ parameters.State }}" + echo "Target URL: ${{ parameters.TargetUrl }}" + echo "Description: ${{ parameters.Description }}" + echo "Context: ${{ parameters.Context }}" + + gh api repos/${{ parameters.RepositoryName }}/statuses/${{ parameters.Sha }} \ + -f state='${{ parameters.State }}' \ + -f target_url='${{ parameters.TargetUrl }}' \ + -f description='${{ parameters.Description }}' \ + -f context='${{ parameters.Context }}' + displayName: ${{ parameters.DisplayName }} + condition: ${{ parameters.Condition }} + env: + GH_TOKEN: ${{ parameters.GitHubToken }} diff --git a/eng/scripts/Create-APIView.ps1 b/eng/scripts/Create-APIView.ps1 index e855e93765e6..999129e68946 100644 --- a/eng/scripts/Create-APIView.ps1 +++ b/eng/scripts/Create-APIView.ps1 @@ -464,7 +464,7 @@ function New-TypeSpecAPIViewTokens { LogGroupEnd foreach ($typeSpecProject in $typeSpecProjects) { # Skip Baseline APIView Token for new projects - if (!(Test-Path -Path $typeSpecProject)) { + if (!(Test-Path -Path (Join-Path $typeSpecProject "tspconfig.yaml"))) { Write-Host "TypeSpec project $typeSpecProject is not found in pull request target branch. API review will not have a baseline revision." } else { diff --git a/package-lock.json b/package-lock.json index 097d5ed5e6f8..1c9106567e6c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -51,6 +51,7 @@ "simple-git": "^3.27.0" }, "bin": { + "api-doc-preview": "cmd/api-doc-preview.js", "spec-model": "cmd/spec-model.js" }, "devDependencies": { @@ -133,9 +134,9 @@ } }, "eng/tools/lint-diff/node_modules/@types/node": { - "version": "18.19.119", - "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.119.tgz", - "integrity": "sha512-d0F6m9itIPaKnrvEMlzE48UjwZaAnFW7Jwibacw9MNdqadjKNpUm9tfJYDwmShJmgqcoqYUX3EMKO1+RWiuuNg==", + "version": "18.19.120", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.120.tgz", + "integrity": "sha512-WtCGHFXnVI8WHLxDAt5TbnCM4eSE+nI0QN2NJtwzcgMhht2eNz6V9evJrk+lwC8bCY8OWV5Ym8Jz7ZEyGnKnMA==", "dev": true, "license": "MIT", "dependencies": { @@ -590,9 +591,9 @@ } }, "eng/tools/typespec-migration-validation/node_modules/@types/node": { - "version": "18.19.119", - "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.119.tgz", - "integrity": "sha512-d0F6m9itIPaKnrvEMlzE48UjwZaAnFW7Jwibacw9MNdqadjKNpUm9tfJYDwmShJmgqcoqYUX3EMKO1+RWiuuNg==", + "version": "18.19.120", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.120.tgz", + "integrity": "sha512-WtCGHFXnVI8WHLxDAt5TbnCM4eSE+nI0QN2NJtwzcgMhht2eNz6V9evJrk+lwC8bCY8OWV5Ym8Jz7ZEyGnKnMA==", "dev": true, "license": "MIT", "dependencies": { @@ -1607,15 +1608,16 @@ } }, "node_modules/@azure/ms-rest-js/node_modules/form-data": { - "version": "2.5.3", - "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.5.3.tgz", - "integrity": "sha512-XHIrMD0NpDrNM/Ckf7XJiBbLl57KEhT3+i3yY+eWm+cqYZJQTZrKo8Y8AWKnuV5GT4scfuUGt9LzNoIx3dU1nQ==", + "version": "2.5.5", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.5.5.tgz", + "integrity": "sha512-jqdObeR2rxZZbPSGL+3VckHMYtu+f9//KXBsVny6JSX/pa38Fy+bGjuG8eW/H6USNQWhLi8Num++cU2yOCNz4A==", "dev": true, "license": "MIT", "dependencies": { "asynckit": "^0.4.0", "combined-stream": "^1.0.8", "es-set-tostringtag": "^2.1.0", + "hasown": "^2.0.2", "mime-types": "^2.1.35", "safe-buffer": "^5.2.1" }, @@ -1842,13 +1844,13 @@ } }, "node_modules/@azure/oad/node_modules/source-map": { - "version": "0.7.4", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.4.tgz", - "integrity": "sha512-l3BikUxvPOcn5E74dZiq5BGsTb5yEwhaTSzccU6t4sDOH8NWJCstKO5QT2CvtFoK6F0saL7p9xHAqHOlCPJygA==", + "version": "0.7.6", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.6.tgz", + "integrity": "sha512-i5uvt8C3ikiWeNZSVZNWcfZPItFQOsYTUAOkcUPGd8DqDy1uOUikjt5dG+uRlwyvR108Fb9DOd4GvXfT0N2/uQ==", "dev": true, "license": "BSD-3-Clause", "engines": { - "node": ">= 8" + "node": ">= 12" } }, "node_modules/@azure/oad/node_modules/string-width": { @@ -2057,9 +2059,9 @@ } }, "node_modules/@babel/types": { - "version": "7.28.1", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.28.1.tgz", - "integrity": "sha512-x0LvFTekgSX+83TI28Y9wYPUfzrnl2aT5+5QLnO6v7mSJYtEEevuDRN0F0uSHRk1G1IWZC43o00Y0xDDrpBGPQ==", + "version": "7.28.2", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.28.2.tgz", + "integrity": "sha512-ruv7Ae4J5dUYULmeXw1gmb7rYRz57OWCPM57pHojnLq/3Z1CK2lNSLTCVjxVk1F/TZHwOZZrOWi0ur95BbLxNQ==", "dev": true, "license": "MIT", "dependencies": { @@ -2104,9 +2106,9 @@ } }, "node_modules/@esbuild/aix-ppc64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.6.tgz", - "integrity": "sha512-ShbM/3XxwuxjFiuVBHA+d3j5dyac0aEVVq1oluIDf71hUw0aRF59dV/efUsIwFnR6m8JNM2FjZOzmaZ8yG61kw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.8.tgz", + "integrity": "sha512-urAvrUedIqEiFR3FYSLTWQgLu5tb+m0qZw0NBEasUeo6wuqatkMDaRT+1uABiGXEu5vqgPd7FGE1BhsAIy9QVA==", "cpu": [ "ppc64" ], @@ -2121,9 +2123,9 @@ } }, "node_modules/@esbuild/android-arm": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.25.6.tgz", - "integrity": "sha512-S8ToEOVfg++AU/bHwdksHNnyLyVM+eMVAOf6yRKFitnwnbwwPNqKr3srzFRe7nzV69RQKb5DgchIX5pt3L53xg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.25.8.tgz", + "integrity": "sha512-RONsAvGCz5oWyePVnLdZY/HHwA++nxYWIX1atInlaW6SEkwq6XkP3+cb825EUcRs5Vss/lGh/2YxAb5xqc07Uw==", "cpu": [ "arm" ], @@ -2138,9 +2140,9 @@ } }, "node_modules/@esbuild/android-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.25.6.tgz", - "integrity": "sha512-hd5zdUarsK6strW+3Wxi5qWws+rJhCCbMiC9QZyzoxfk5uHRIE8T287giQxzVpEvCwuJ9Qjg6bEjcRJcgfLqoA==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.25.8.tgz", + "integrity": "sha512-OD3p7LYzWpLhZEyATcTSJ67qB5D+20vbtr6vHlHWSQYhKtzUYrETuWThmzFpZtFsBIxRvhO07+UgVA9m0i/O1w==", "cpu": [ "arm64" ], @@ -2155,9 +2157,9 @@ } }, "node_modules/@esbuild/android-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.25.6.tgz", - "integrity": "sha512-0Z7KpHSr3VBIO9A/1wcT3NTy7EB4oNC4upJ5ye3R7taCc2GUdeynSLArnon5G8scPwaU866d3H4BCrE5xLW25A==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.25.8.tgz", + "integrity": "sha512-yJAVPklM5+4+9dTeKwHOaA+LQkmrKFX96BM0A/2zQrbS6ENCmxc4OVoBs5dPkCCak2roAD+jKCdnmOqKszPkjA==", "cpu": [ "x64" ], @@ -2172,9 +2174,9 @@ } }, "node_modules/@esbuild/darwin-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.25.6.tgz", - "integrity": "sha512-FFCssz3XBavjxcFxKsGy2DYK5VSvJqa6y5HXljKzhRZ87LvEi13brPrf/wdyl/BbpbMKJNOr1Sd0jtW4Ge1pAA==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.25.8.tgz", + "integrity": "sha512-Jw0mxgIaYX6R8ODrdkLLPwBqHTtYHJSmzzd+QeytSugzQ0Vg4c5rDky5VgkoowbZQahCbsv1rT1KW72MPIkevw==", "cpu": [ "arm64" ], @@ -2189,9 +2191,9 @@ } }, "node_modules/@esbuild/darwin-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.25.6.tgz", - "integrity": "sha512-GfXs5kry/TkGM2vKqK2oyiLFygJRqKVhawu3+DOCk7OxLy/6jYkWXhlHwOoTb0WqGnWGAS7sooxbZowy+pK9Yg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.25.8.tgz", + "integrity": "sha512-Vh2gLxxHnuoQ+GjPNvDSDRpoBCUzY4Pu0kBqMBDlK4fuWbKgGtmDIeEC081xi26PPjn+1tct+Bh8FjyLlw1Zlg==", "cpu": [ "x64" ], @@ -2206,9 +2208,9 @@ } }, "node_modules/@esbuild/freebsd-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.25.6.tgz", - "integrity": "sha512-aoLF2c3OvDn2XDTRvn8hN6DRzVVpDlj2B/F66clWd/FHLiHaG3aVZjxQX2DYphA5y/evbdGvC6Us13tvyt4pWg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.25.8.tgz", + "integrity": "sha512-YPJ7hDQ9DnNe5vxOm6jaie9QsTwcKedPvizTVlqWG9GBSq+BuyWEDazlGaDTC5NGU4QJd666V0yqCBL2oWKPfA==", "cpu": [ "arm64" ], @@ -2223,9 +2225,9 @@ } }, "node_modules/@esbuild/freebsd-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.25.6.tgz", - "integrity": "sha512-2SkqTjTSo2dYi/jzFbU9Plt1vk0+nNg8YC8rOXXea+iA3hfNJWebKYPs3xnOUf9+ZWhKAaxnQNUf2X9LOpeiMQ==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.25.8.tgz", + "integrity": "sha512-MmaEXxQRdXNFsRN/KcIimLnSJrk2r5H8v+WVafRWz5xdSVmWLoITZQXcgehI2ZE6gioE6HirAEToM/RvFBeuhw==", "cpu": [ "x64" ], @@ -2240,9 +2242,9 @@ } }, "node_modules/@esbuild/linux-arm": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.25.6.tgz", - "integrity": "sha512-SZHQlzvqv4Du5PrKE2faN0qlbsaW/3QQfUUc6yO2EjFcA83xnwm91UbEEVx4ApZ9Z5oG8Bxz4qPE+HFwtVcfyw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.25.8.tgz", + "integrity": "sha512-FuzEP9BixzZohl1kLf76KEVOsxtIBFwCaLupVuk4eFVnOZfU+Wsn+x5Ryam7nILV2pkq2TqQM9EZPsOBuMC+kg==", "cpu": [ "arm" ], @@ -2257,9 +2259,9 @@ } }, "node_modules/@esbuild/linux-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.25.6.tgz", - "integrity": "sha512-b967hU0gqKd9Drsh/UuAm21Khpoh6mPBSgz8mKRq4P5mVK8bpA+hQzmm/ZwGVULSNBzKdZPQBRT3+WuVavcWsQ==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.25.8.tgz", + "integrity": "sha512-WIgg00ARWv/uYLU7lsuDK00d/hHSfES5BzdWAdAig1ioV5kaFNrtK8EqGcUBJhYqotlUByUKz5Qo6u8tt7iD/w==", "cpu": [ "arm64" ], @@ -2274,9 +2276,9 @@ } }, "node_modules/@esbuild/linux-ia32": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.25.6.tgz", - "integrity": "sha512-aHWdQ2AAltRkLPOsKdi3xv0mZ8fUGPdlKEjIEhxCPm5yKEThcUjHpWB1idN74lfXGnZ5SULQSgtr5Qos5B0bPw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.25.8.tgz", + "integrity": "sha512-A1D9YzRX1i+1AJZuFFUMP1E9fMaYY+GnSQil9Tlw05utlE86EKTUA7RjwHDkEitmLYiFsRd9HwKBPEftNdBfjg==", "cpu": [ "ia32" ], @@ -2291,9 +2293,9 @@ } }, "node_modules/@esbuild/linux-loong64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.25.6.tgz", - "integrity": "sha512-VgKCsHdXRSQ7E1+QXGdRPlQ/e08bN6WMQb27/TMfV+vPjjTImuT9PmLXupRlC90S1JeNNW5lzkAEO/McKeJ2yg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.25.8.tgz", + "integrity": "sha512-O7k1J/dwHkY1RMVvglFHl1HzutGEFFZ3kNiDMSOyUrB7WcoHGf96Sh+64nTRT26l3GMbCW01Ekh/ThKM5iI7hQ==", "cpu": [ "loong64" ], @@ -2308,9 +2310,9 @@ } }, "node_modules/@esbuild/linux-mips64el": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.25.6.tgz", - "integrity": "sha512-WViNlpivRKT9/py3kCmkHnn44GkGXVdXfdc4drNmRl15zVQ2+D2uFwdlGh6IuK5AAnGTo2qPB1Djppj+t78rzw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.25.8.tgz", + "integrity": "sha512-uv+dqfRazte3BzfMp8PAQXmdGHQt2oC/y2ovwpTteqrMx2lwaksiFZ/bdkXJC19ttTvNXBuWH53zy/aTj1FgGw==", "cpu": [ "mips64el" ], @@ -2325,9 +2327,9 @@ } }, "node_modules/@esbuild/linux-ppc64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.25.6.tgz", - "integrity": "sha512-wyYKZ9NTdmAMb5730I38lBqVu6cKl4ZfYXIs31Baf8aoOtB4xSGi3THmDYt4BTFHk7/EcVixkOV2uZfwU3Q2Jw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.25.8.tgz", + "integrity": "sha512-GyG0KcMi1GBavP5JgAkkstMGyMholMDybAf8wF5A70CALlDM2p/f7YFE7H92eDeH/VBtFJA5MT4nRPDGg4JuzQ==", "cpu": [ "ppc64" ], @@ -2342,9 +2344,9 @@ } }, "node_modules/@esbuild/linux-riscv64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.25.6.tgz", - "integrity": "sha512-KZh7bAGGcrinEj4qzilJ4hqTY3Dg2U82c8bv+e1xqNqZCrCyc+TL9AUEn5WGKDzm3CfC5RODE/qc96OcbIe33w==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.25.8.tgz", + "integrity": "sha512-rAqDYFv3yzMrq7GIcen3XP7TUEG/4LK86LUPMIz6RT8A6pRIDn0sDcvjudVZBiiTcZCY9y2SgYX2lgK3AF+1eg==", "cpu": [ "riscv64" ], @@ -2359,9 +2361,9 @@ } }, "node_modules/@esbuild/linux-s390x": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.25.6.tgz", - "integrity": "sha512-9N1LsTwAuE9oj6lHMyyAM+ucxGiVnEqUdp4v7IaMmrwb06ZTEVCIs3oPPplVsnjPfyjmxwHxHMF8b6vzUVAUGw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.25.8.tgz", + "integrity": "sha512-Xutvh6VjlbcHpsIIbwY8GVRbwoviWT19tFhgdA7DlenLGC/mbc3lBoVb7jxj9Z+eyGqvcnSyIltYUrkKzWqSvg==", "cpu": [ "s390x" ], @@ -2376,9 +2378,9 @@ } }, "node_modules/@esbuild/linux-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.6.tgz", - "integrity": "sha512-A6bJB41b4lKFWRKNrWoP2LHsjVzNiaurf7wyj/XtFNTsnPuxwEBWHLty+ZE0dWBKuSK1fvKgrKaNjBS7qbFKig==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.8.tgz", + "integrity": "sha512-ASFQhgY4ElXh3nDcOMTkQero4b1lgubskNlhIfJrsH5OKZXDpUAKBlNS0Kx81jwOBp+HCeZqmoJuihTv57/jvQ==", "cpu": [ "x64" ], @@ -2393,9 +2395,9 @@ } }, "node_modules/@esbuild/netbsd-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.25.6.tgz", - "integrity": "sha512-IjA+DcwoVpjEvyxZddDqBY+uJ2Snc6duLpjmkXm/v4xuS3H+3FkLZlDm9ZsAbF9rsfP3zeA0/ArNDORZgrxR/Q==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.25.8.tgz", + "integrity": "sha512-d1KfruIeohqAi6SA+gENMuObDbEjn22olAR7egqnkCD9DGBG0wsEARotkLgXDu6c4ncgWTZJtN5vcgxzWRMzcw==", "cpu": [ "arm64" ], @@ -2410,9 +2412,9 @@ } }, "node_modules/@esbuild/netbsd-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.25.6.tgz", - "integrity": "sha512-dUXuZr5WenIDlMHdMkvDc1FAu4xdWixTCRgP7RQLBOkkGgwuuzaGSYcOpW4jFxzpzL1ejb8yF620UxAqnBrR9g==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.25.8.tgz", + "integrity": "sha512-nVDCkrvx2ua+XQNyfrujIG38+YGyuy2Ru9kKVNyh5jAys6n+l44tTtToqHjino2My8VAY6Lw9H7RI73XFi66Cg==", "cpu": [ "x64" ], @@ -2427,9 +2429,9 @@ } }, "node_modules/@esbuild/openbsd-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.25.6.tgz", - "integrity": "sha512-l8ZCvXP0tbTJ3iaqdNf3pjaOSd5ex/e6/omLIQCVBLmHTlfXW3zAxQ4fnDmPLOB1x9xrcSi/xtCWFwCZRIaEwg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.25.8.tgz", + "integrity": "sha512-j8HgrDuSJFAujkivSMSfPQSAa5Fxbvk4rgNAS5i3K+r8s1X0p1uOO2Hl2xNsGFppOeHOLAVgYwDVlmxhq5h+SQ==", "cpu": [ "arm64" ], @@ -2444,9 +2446,9 @@ } }, "node_modules/@esbuild/openbsd-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.25.6.tgz", - "integrity": "sha512-hKrmDa0aOFOr71KQ/19JC7az1P0GWtCN1t2ahYAf4O007DHZt/dW8ym5+CUdJhQ/qkZmI1HAF8KkJbEFtCL7gw==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.25.8.tgz", + "integrity": "sha512-1h8MUAwa0VhNCDp6Af0HToI2TJFAn1uqT9Al6DJVzdIBAd21m/G0Yfc77KDM3uF3T/YaOgQq3qTJHPbTOInaIQ==", "cpu": [ "x64" ], @@ -2461,9 +2463,9 @@ } }, "node_modules/@esbuild/openharmony-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.25.6.tgz", - "integrity": "sha512-+SqBcAWoB1fYKmpWoQP4pGtx+pUUC//RNYhFdbcSA16617cchuryuhOCRpPsjCblKukAckWsV+aQ3UKT/RMPcA==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.25.8.tgz", + "integrity": "sha512-r2nVa5SIK9tSWd0kJd9HCffnDHKchTGikb//9c7HX+r+wHYCpQrSgxhlY6KWV1nFo1l4KFbsMlHk+L6fekLsUg==", "cpu": [ "arm64" ], @@ -2478,9 +2480,9 @@ } }, "node_modules/@esbuild/sunos-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.25.6.tgz", - "integrity": "sha512-dyCGxv1/Br7MiSC42qinGL8KkG4kX0pEsdb0+TKhmJZgCUDBGmyo1/ArCjNGiOLiIAgdbWgmWgib4HoCi5t7kA==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.25.8.tgz", + "integrity": "sha512-zUlaP2S12YhQ2UzUfcCuMDHQFJyKABkAjvO5YSndMiIkMimPmxA+BYSBikWgsRpvyxuRnow4nS5NPnf9fpv41w==", "cpu": [ "x64" ], @@ -2495,9 +2497,9 @@ } }, "node_modules/@esbuild/win32-arm64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.25.6.tgz", - "integrity": "sha512-42QOgcZeZOvXfsCBJF5Afw73t4veOId//XD3i+/9gSkhSV6Gk3VPlWncctI+JcOyERv85FUo7RxuxGy+z8A43Q==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.25.8.tgz", + "integrity": "sha512-YEGFFWESlPva8hGL+zvj2z/SaK+pH0SwOM0Nc/d+rVnW7GSTFlLBGzZkuSU9kFIGIo8q9X3ucpZhu8PDN5A2sQ==", "cpu": [ "arm64" ], @@ -2512,9 +2514,9 @@ } }, "node_modules/@esbuild/win32-ia32": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.25.6.tgz", - "integrity": "sha512-4AWhgXmDuYN7rJI6ORB+uU9DHLq/erBbuMoAuB4VWJTu5KtCgcKYPynF0YI1VkBNuEfjNlLrFr9KZPJzrtLkrQ==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.25.8.tgz", + "integrity": "sha512-hiGgGC6KZ5LZz58OL/+qVVoZiuZlUYlYHNAmczOm7bs2oE1XriPFi5ZHHrS8ACpV5EjySrnoCKmcbQMN+ojnHg==", "cpu": [ "ia32" ], @@ -2529,9 +2531,9 @@ } }, "node_modules/@esbuild/win32-x64": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.25.6.tgz", - "integrity": "sha512-NgJPHHbEpLQgDH2MjQu90pzW/5vvXIZ7KOnPyNBm92A6WgZ/7b6fJyUBjoumLqeOQQGqY2QjQxRo97ah4Sj0cA==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.25.8.tgz", + "integrity": "sha512-cn3Yr7+OaaZq1c+2pe+8yxC8E144SReCQjN6/2ynubzYjvyqZjTXfQJpAcQpsdJq3My7XADANiYGHoFC69pLQw==", "cpu": [ "x64" ], @@ -2686,9 +2688,9 @@ } }, "node_modules/@eslint/plugin-kit": { - "version": "0.3.3", - "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.3.3.tgz", - "integrity": "sha512-1+WqvgNMhmlAambTvT3KPtCl/Ibr68VldY2XY40SL1CE0ZXiakFR/cbTspaF5HsnpDMvcYYoJHfl4980NBjGag==", + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.3.4.tgz", + "integrity": "sha512-Ul5l+lHEcw3L5+k8POx6r74mxEYKG5kOb6Xpy2gCRW6zweT6TEhAf8vhxGgjhqrd/VO/Dirhsb+1hNpD1ue9hw==", "dev": true, "license": "Apache-2.0", "dependencies": { @@ -2783,15 +2785,15 @@ } }, "node_modules/@inquirer/checkbox": { - "version": "4.1.9", - "resolved": "https://registry.npmjs.org/@inquirer/checkbox/-/checkbox-4.1.9.tgz", - "integrity": "sha512-DBJBkzI5Wx4jFaYm221LHvAhpKYkhVS0k9plqHwaHhofGNxvYB7J3Bz8w+bFJ05zaMb0sZNHo4KdmENQFlNTuQ==", + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/@inquirer/checkbox/-/checkbox-4.2.0.tgz", + "integrity": "sha512-fdSw07FLJEU5vbpOPzXo5c6xmMGDzbZE2+niuDHX5N6mc6V0Ebso/q3xiHra4D73+PMsC8MJmcaZKuAAoaQsSA==", "dev": true, "license": "MIT", "dependencies": { - "@inquirer/core": "^10.1.14", - "@inquirer/figures": "^1.0.12", - "@inquirer/type": "^3.0.7", + "@inquirer/core": "^10.1.15", + "@inquirer/figures": "^1.0.13", + "@inquirer/type": "^3.0.8", "ansi-escapes": "^4.3.2", "yoctocolors-cjs": "^2.1.2" }, @@ -2808,14 +2810,14 @@ } }, "node_modules/@inquirer/confirm": { - "version": "5.1.13", - "resolved": "https://registry.npmjs.org/@inquirer/confirm/-/confirm-5.1.13.tgz", - "integrity": "sha512-EkCtvp67ICIVVzjsquUiVSd+V5HRGOGQfsqA4E4vMWhYnB7InUL0pa0TIWt1i+OfP16Gkds8CdIu6yGZwOM1Yw==", + "version": "5.1.14", + "resolved": "https://registry.npmjs.org/@inquirer/confirm/-/confirm-5.1.14.tgz", + "integrity": "sha512-5yR4IBfe0kXe59r1YCTG8WXkUbl7Z35HK87Sw+WUyGD8wNUx7JvY7laahzeytyE1oLn74bQnL7hstctQxisQ8Q==", "dev": true, "license": "MIT", "dependencies": { - "@inquirer/core": "^10.1.14", - "@inquirer/type": "^3.0.7" + "@inquirer/core": "^10.1.15", + "@inquirer/type": "^3.0.8" }, "engines": { "node": ">=18" @@ -2830,14 +2832,14 @@ } }, "node_modules/@inquirer/core": { - "version": "10.1.14", - "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.14.tgz", - "integrity": "sha512-Ma+ZpOJPewtIYl6HZHZckeX1STvDnHTCB2GVINNUlSEn2Am6LddWwfPkIGY0IUFVjUUrr/93XlBwTK6mfLjf0A==", + "version": "10.1.15", + "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.15.tgz", + "integrity": "sha512-8xrp836RZvKkpNbVvgWUlxjT4CraKk2q+I3Ksy+seI2zkcE+y6wNs1BVhgcv8VyImFecUhdQrYLdW32pAjwBdA==", "dev": true, "license": "MIT", "dependencies": { - "@inquirer/figures": "^1.0.12", - "@inquirer/type": "^3.0.7", + "@inquirer/figures": "^1.0.13", + "@inquirer/type": "^3.0.8", "ansi-escapes": "^4.3.2", "cli-width": "^4.1.0", "mute-stream": "^2.0.0", @@ -2858,14 +2860,14 @@ } }, "node_modules/@inquirer/editor": { - "version": "4.2.14", - "resolved": "https://registry.npmjs.org/@inquirer/editor/-/editor-4.2.14.tgz", - "integrity": "sha512-yd2qtLl4QIIax9DTMZ1ZN2pFrrj+yL3kgIWxm34SS6uwCr0sIhsNyudUjAo5q3TqI03xx4SEBkUJqZuAInp9uA==", + "version": "4.2.15", + "resolved": "https://registry.npmjs.org/@inquirer/editor/-/editor-4.2.15.tgz", + "integrity": "sha512-wst31XT8DnGOSS4nNJDIklGKnf+8shuauVrWzgKegWUe28zfCftcWZ2vktGdzJgcylWSS2SrDnYUb6alZcwnCQ==", "dev": true, "license": "MIT", "dependencies": { - "@inquirer/core": "^10.1.14", - "@inquirer/type": "^3.0.7", + "@inquirer/core": "^10.1.15", + "@inquirer/type": "^3.0.8", "external-editor": "^3.1.0" }, "engines": { @@ -2881,14 +2883,14 @@ } }, "node_modules/@inquirer/expand": { - "version": "4.0.16", - "resolved": "https://registry.npmjs.org/@inquirer/expand/-/expand-4.0.16.tgz", - "integrity": "sha512-oiDqafWzMtofeJyyGkb1CTPaxUkjIcSxePHHQCfif8t3HV9pHcw1Kgdw3/uGpDvaFfeTluwQtWiqzPVjAqS3zA==", + "version": "4.0.17", + "resolved": "https://registry.npmjs.org/@inquirer/expand/-/expand-4.0.17.tgz", + "integrity": "sha512-PSqy9VmJx/VbE3CT453yOfNa+PykpKg/0SYP7odez1/NWBGuDXgPhp4AeGYYKjhLn5lUUavVS/JbeYMPdH50Mw==", "dev": true, "license": "MIT", "dependencies": { - "@inquirer/core": "^10.1.14", - "@inquirer/type": "^3.0.7", + "@inquirer/core": "^10.1.15", + "@inquirer/type": "^3.0.8", "yoctocolors-cjs": "^2.1.2" }, "engines": { @@ -2904,9 +2906,9 @@ } }, "node_modules/@inquirer/figures": { - "version": "1.0.12", - "resolved": "https://registry.npmjs.org/@inquirer/figures/-/figures-1.0.12.tgz", - "integrity": "sha512-MJttijd8rMFcKJC8NYmprWr6hD3r9Gd9qUC0XwPNwoEPWSMVJwA2MlXxF+nhZZNMY+HXsWa+o7KY2emWYIn0jQ==", + "version": "1.0.13", + "resolved": "https://registry.npmjs.org/@inquirer/figures/-/figures-1.0.13.tgz", + "integrity": "sha512-lGPVU3yO9ZNqA7vTYz26jny41lE7yoQansmqdMLBEfqaGsmdg7V3W9mK9Pvb5IL4EVZ9GnSDGMO/cJXud5dMaw==", "dev": true, "license": "MIT", "engines": { @@ -2914,14 +2916,14 @@ } }, "node_modules/@inquirer/input": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/@inquirer/input/-/input-4.2.0.tgz", - "integrity": "sha512-opqpHPB1NjAmDISi3uvZOTrjEEU5CWVu/HBkDby8t93+6UxYX0Z7Ps0Ltjm5sZiEbWenjubwUkivAEYQmy9xHw==", + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/@inquirer/input/-/input-4.2.1.tgz", + "integrity": "sha512-tVC+O1rBl0lJpoUZv4xY+WGWY8V5b0zxU1XDsMsIHYregdh7bN5X5QnIONNBAl0K765FYlAfNHS2Bhn7SSOVow==", "dev": true, "license": "MIT", "dependencies": { - "@inquirer/core": "^10.1.14", - "@inquirer/type": "^3.0.7" + "@inquirer/core": "^10.1.15", + "@inquirer/type": "^3.0.8" }, "engines": { "node": ">=18" @@ -2936,14 +2938,14 @@ } }, "node_modules/@inquirer/number": { - "version": "3.0.16", - "resolved": "https://registry.npmjs.org/@inquirer/number/-/number-3.0.16.tgz", - "integrity": "sha512-kMrXAaKGavBEoBYUCgualbwA9jWUx2TjMA46ek+pEKy38+LFpL9QHlTd8PO2kWPUgI/KB+qi02o4y2rwXbzr3Q==", + "version": "3.0.17", + "resolved": "https://registry.npmjs.org/@inquirer/number/-/number-3.0.17.tgz", + "integrity": "sha512-GcvGHkyIgfZgVnnimURdOueMk0CztycfC8NZTiIY9arIAkeOgt6zG57G+7vC59Jns3UX27LMkPKnKWAOF5xEYg==", "dev": true, "license": "MIT", "dependencies": { - "@inquirer/core": "^10.1.14", - "@inquirer/type": "^3.0.7" + "@inquirer/core": "^10.1.15", + "@inquirer/type": "^3.0.8" }, "engines": { "node": ">=18" @@ -2958,14 +2960,14 @@ } }, "node_modules/@inquirer/password": { - "version": "4.0.16", - "resolved": "https://registry.npmjs.org/@inquirer/password/-/password-4.0.16.tgz", - "integrity": "sha512-g8BVNBj5Zeb5/Y3cSN+hDUL7CsIFDIuVxb9EPty3lkxBaYpjL5BNRKSYOF9yOLe+JOcKFd+TSVeADQ4iSY7rbg==", + "version": "4.0.17", + "resolved": "https://registry.npmjs.org/@inquirer/password/-/password-4.0.17.tgz", + "integrity": "sha512-DJolTnNeZ00E1+1TW+8614F7rOJJCM4y4BAGQ3Gq6kQIG+OJ4zr3GLjIjVVJCbKsk2jmkmv6v2kQuN/vriHdZA==", "dev": true, "license": "MIT", "dependencies": { - "@inquirer/core": "^10.1.14", - "@inquirer/type": "^3.0.7", + "@inquirer/core": "^10.1.15", + "@inquirer/type": "^3.0.8", "ansi-escapes": "^4.3.2" }, "engines": { @@ -2981,22 +2983,22 @@ } }, "node_modules/@inquirer/prompts": { - "version": "7.6.0", - "resolved": "https://registry.npmjs.org/@inquirer/prompts/-/prompts-7.6.0.tgz", - "integrity": "sha512-jAhL7tyMxB3Gfwn4HIJ0yuJ5pvcB5maYUcouGcgd/ub79f9MqZ+aVnBtuFf+VC2GTkCBF+R+eo7Vi63w5VZlzw==", + "version": "7.7.1", + "resolved": "https://registry.npmjs.org/@inquirer/prompts/-/prompts-7.7.1.tgz", + "integrity": "sha512-XDxPrEWeWUBy8scAXzXuFY45r/q49R0g72bUzgQXZ1DY/xEFX+ESDMkTQolcb5jRBzaNJX2W8XQl6krMNDTjaA==", "dev": true, "license": "MIT", "dependencies": { - "@inquirer/checkbox": "^4.1.9", - "@inquirer/confirm": "^5.1.13", - "@inquirer/editor": "^4.2.14", - "@inquirer/expand": "^4.0.16", - "@inquirer/input": "^4.2.0", - "@inquirer/number": "^3.0.16", - "@inquirer/password": "^4.0.16", - "@inquirer/rawlist": "^4.1.4", - "@inquirer/search": "^3.0.16", - "@inquirer/select": "^4.2.4" + "@inquirer/checkbox": "^4.2.0", + "@inquirer/confirm": "^5.1.14", + "@inquirer/editor": "^4.2.15", + "@inquirer/expand": "^4.0.17", + "@inquirer/input": "^4.2.1", + "@inquirer/number": "^3.0.17", + "@inquirer/password": "^4.0.17", + "@inquirer/rawlist": "^4.1.5", + "@inquirer/search": "^3.0.17", + "@inquirer/select": "^4.3.1" }, "engines": { "node": ">=18" @@ -3011,14 +3013,14 @@ } }, "node_modules/@inquirer/rawlist": { - "version": "4.1.4", - "resolved": "https://registry.npmjs.org/@inquirer/rawlist/-/rawlist-4.1.4.tgz", - "integrity": "sha512-5GGvxVpXXMmfZNtvWw4IsHpR7RzqAR624xtkPd1NxxlV5M+pShMqzL4oRddRkg8rVEOK9fKdJp1jjVML2Lr7TQ==", + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/@inquirer/rawlist/-/rawlist-4.1.5.tgz", + "integrity": "sha512-R5qMyGJqtDdi4Ht521iAkNqyB6p2UPuZUbMifakg1sWtu24gc2Z8CJuw8rP081OckNDMgtDCuLe42Q2Kr3BolA==", "dev": true, "license": "MIT", "dependencies": { - "@inquirer/core": "^10.1.14", - "@inquirer/type": "^3.0.7", + "@inquirer/core": "^10.1.15", + "@inquirer/type": "^3.0.8", "yoctocolors-cjs": "^2.1.2" }, "engines": { @@ -3034,15 +3036,15 @@ } }, "node_modules/@inquirer/search": { - "version": "3.0.16", - "resolved": "https://registry.npmjs.org/@inquirer/search/-/search-3.0.16.tgz", - "integrity": "sha512-POCmXo+j97kTGU6aeRjsPyuCpQQfKcMXdeTMw708ZMtWrj5aykZvlUxH4Qgz3+Y1L/cAVZsSpA+UgZCu2GMOMg==", + "version": "3.0.17", + "resolved": "https://registry.npmjs.org/@inquirer/search/-/search-3.0.17.tgz", + "integrity": "sha512-CuBU4BAGFqRYors4TNCYzy9X3DpKtgIW4Boi0WNkm4Ei1hvY9acxKdBdyqzqBCEe4YxSdaQQsasJlFlUJNgojw==", "dev": true, "license": "MIT", "dependencies": { - "@inquirer/core": "^10.1.14", - "@inquirer/figures": "^1.0.12", - "@inquirer/type": "^3.0.7", + "@inquirer/core": "^10.1.15", + "@inquirer/figures": "^1.0.13", + "@inquirer/type": "^3.0.8", "yoctocolors-cjs": "^2.1.2" }, "engines": { @@ -3058,15 +3060,15 @@ } }, "node_modules/@inquirer/select": { - "version": "4.2.4", - "resolved": "https://registry.npmjs.org/@inquirer/select/-/select-4.2.4.tgz", - "integrity": "sha512-unTppUcTjmnbl/q+h8XeQDhAqIOmwWYWNyiiP2e3orXrg6tOaa5DHXja9PChCSbChOsktyKgOieRZFnajzxoBg==", + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/@inquirer/select/-/select-4.3.1.tgz", + "integrity": "sha512-Gfl/5sqOF5vS/LIrSndFgOh7jgoe0UXEizDqahFRkq5aJBLegZ6WjuMh/hVEJwlFQjyLq1z9fRtvUMkb7jM1LA==", "dev": true, "license": "MIT", "dependencies": { - "@inquirer/core": "^10.1.14", - "@inquirer/figures": "^1.0.12", - "@inquirer/type": "^3.0.7", + "@inquirer/core": "^10.1.15", + "@inquirer/figures": "^1.0.13", + "@inquirer/type": "^3.0.8", "ansi-escapes": "^4.3.2", "yoctocolors-cjs": "^2.1.2" }, @@ -3083,9 +3085,9 @@ } }, "node_modules/@inquirer/type": { - "version": "3.0.7", - "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.7.tgz", - "integrity": "sha512-PfunHQcjwnju84L+ycmcMKB/pTPIngjUJvfnRhKY6FKPuYXlM4aQCb/nIdTFR6BEhMjFvngzvng/vBAJMZpLSA==", + "version": "3.0.8", + "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.8.tgz", + "integrity": "sha512-lg9Whz8onIHRthWaN1Q9EGLa/0LFJjyM8mEUbL1eTi6yMGvBf8gvyDLtxSXztQsxMvhxxNpJYrwa1YHdq+w4Jw==", "dev": true, "license": "MIT", "engines": { @@ -4963,9 +4965,9 @@ "license": "MIT" }, "node_modules/@types/node": { - "version": "20.19.8", - "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.8.tgz", - "integrity": "sha512-HzbgCY53T6bfu4tT7Aq3TvViJyHjLjPNaAS3HOuMc9pw97KHsUtXNX4L+wu59g1WnjsZSko35MbEqnO58rihhw==", + "version": "20.19.9", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.9.tgz", + "integrity": "sha512-cuVNgarYWZqxRJDQHEB58GEONhOK79QVR/qYx4S7kcUObQvUwvFnYxJuuHUKm2aieN9X3yZB4LZsuYNU1Qphsw==", "dev": true, "license": "MIT", "dependencies": { @@ -5032,17 +5034,17 @@ "license": "MIT" }, "node_modules/@typescript-eslint/eslint-plugin": { - "version": "8.37.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.37.0.tgz", - "integrity": "sha512-jsuVWeIkb6ggzB+wPCsR4e6loj+rM72ohW6IBn2C+5NCvfUVY8s33iFPySSVXqtm5Hu29Ne/9bnA0JmyLmgenA==", + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.38.0.tgz", + "integrity": "sha512-CPoznzpuAnIOl4nhj4tRr4gIPj5AfKgkiJmGQDaq+fQnRJTYlcBjbX3wbciGmpoPf8DREufuPRe1tNMZnGdanA==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/regexpp": "^4.10.0", - "@typescript-eslint/scope-manager": "8.37.0", - "@typescript-eslint/type-utils": "8.37.0", - "@typescript-eslint/utils": "8.37.0", - "@typescript-eslint/visitor-keys": "8.37.0", + "@typescript-eslint/scope-manager": "8.38.0", + "@typescript-eslint/type-utils": "8.38.0", + "@typescript-eslint/utils": "8.38.0", + "@typescript-eslint/visitor-keys": "8.38.0", "graphemer": "^1.4.0", "ignore": "^7.0.0", "natural-compare": "^1.4.0", @@ -5056,7 +5058,7 @@ "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "@typescript-eslint/parser": "^8.37.0", + "@typescript-eslint/parser": "^8.38.0", "eslint": "^8.57.0 || ^9.0.0", "typescript": ">=4.8.4 <5.9.0" } @@ -5072,16 +5074,16 @@ } }, "node_modules/@typescript-eslint/parser": { - "version": "8.37.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.37.0.tgz", - "integrity": "sha512-kVIaQE9vrN9RLCQMQ3iyRlVJpTiDUY6woHGb30JDkfJErqrQEmtdWH3gV0PBAfGZgQXoqzXOO0T3K6ioApbbAA==", + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.38.0.tgz", + "integrity": "sha512-Zhy8HCvBUEfBECzIl1PKqF4p11+d0aUJS1GeUiuqK9WmOug8YCmC4h4bjyBvMyAMI9sbRczmrYL5lKg/YMbrcQ==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/scope-manager": "8.37.0", - "@typescript-eslint/types": "8.37.0", - "@typescript-eslint/typescript-estree": "8.37.0", - "@typescript-eslint/visitor-keys": "8.37.0", + "@typescript-eslint/scope-manager": "8.38.0", + "@typescript-eslint/types": "8.38.0", + "@typescript-eslint/typescript-estree": "8.38.0", + "@typescript-eslint/visitor-keys": "8.38.0", "debug": "^4.3.4" }, "engines": { @@ -5097,14 +5099,14 @@ } }, "node_modules/@typescript-eslint/project-service": { - "version": "8.37.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/project-service/-/project-service-8.37.0.tgz", - "integrity": "sha512-BIUXYsbkl5A1aJDdYJCBAo8rCEbAvdquQ8AnLb6z5Lp1u3x5PNgSSx9A/zqYc++Xnr/0DVpls8iQ2cJs/izTXA==", + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/project-service/-/project-service-8.38.0.tgz", + "integrity": "sha512-dbK7Jvqcb8c9QfH01YB6pORpqX1mn5gDZc9n63Ak/+jD67oWXn3Gs0M6vddAN+eDXBCS5EmNWzbSxsn9SzFWWg==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/tsconfig-utils": "^8.37.0", - "@typescript-eslint/types": "^8.37.0", + "@typescript-eslint/tsconfig-utils": "^8.38.0", + "@typescript-eslint/types": "^8.38.0", "debug": "^4.3.4" }, "engines": { @@ -5119,14 +5121,14 @@ } }, "node_modules/@typescript-eslint/scope-manager": { - "version": "8.37.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.37.0.tgz", - "integrity": "sha512-0vGq0yiU1gbjKob2q691ybTg9JX6ShiVXAAfm2jGf3q0hdP6/BruaFjL/ManAR/lj05AvYCH+5bbVo0VtzmjOA==", + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.38.0.tgz", + "integrity": "sha512-WJw3AVlFFcdT9Ri1xs/lg8LwDqgekWXWhH3iAF+1ZM+QPd7oxQ6jvtW/JPwzAScxitILUIFs0/AnQ/UWHzbATQ==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.37.0", - "@typescript-eslint/visitor-keys": "8.37.0" + "@typescript-eslint/types": "8.38.0", + "@typescript-eslint/visitor-keys": "8.38.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -5137,9 +5139,9 @@ } }, "node_modules/@typescript-eslint/tsconfig-utils": { - "version": "8.37.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.37.0.tgz", - "integrity": "sha512-1/YHvAVTimMM9mmlPvTec9NP4bobA1RkDbMydxG8omqwJJLEW/Iy2C4adsAESIXU3WGLXFHSZUU+C9EoFWl4Zg==", + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.38.0.tgz", + "integrity": "sha512-Lum9RtSE3EroKk/bYns+sPOodqb2Fv50XOl/gMviMKNvanETUuUcC9ObRbzrJ4VSd2JalPqgSAavwrPiPvnAiQ==", "dev": true, "license": "MIT", "engines": { @@ -5154,15 +5156,15 @@ } }, "node_modules/@typescript-eslint/type-utils": { - "version": "8.37.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.37.0.tgz", - "integrity": "sha512-SPkXWIkVZxhgwSwVq9rqj/4VFo7MnWwVaRNznfQDc/xPYHjXnPfLWn+4L6FF1cAz6e7dsqBeMawgl7QjUMj4Ow==", + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.38.0.tgz", + "integrity": "sha512-c7jAvGEZVf0ao2z+nnz8BUaHZD09Agbh+DY7qvBQqLiz8uJzRgVPj5YvOh8I8uEiH8oIUGIfHzMwUcGVco/SJg==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.37.0", - "@typescript-eslint/typescript-estree": "8.37.0", - "@typescript-eslint/utils": "8.37.0", + "@typescript-eslint/types": "8.38.0", + "@typescript-eslint/typescript-estree": "8.38.0", + "@typescript-eslint/utils": "8.38.0", "debug": "^4.3.4", "ts-api-utils": "^2.1.0" }, @@ -5179,9 +5181,9 @@ } }, "node_modules/@typescript-eslint/types": { - "version": "8.37.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.37.0.tgz", - "integrity": "sha512-ax0nv7PUF9NOVPs+lmQ7yIE7IQmAf8LGcXbMvHX5Gm+YJUYNAl340XkGnrimxZ0elXyoQJuN5sbg6C4evKA4SQ==", + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.38.0.tgz", + "integrity": "sha512-wzkUfX3plUqij4YwWaJyqhiPE5UCRVlFpKn1oCRn2O1bJ592XxWJj8ROQ3JD5MYXLORW84063z3tZTb/cs4Tyw==", "dev": true, "license": "MIT", "engines": { @@ -5193,16 +5195,16 @@ } }, "node_modules/@typescript-eslint/typescript-estree": { - "version": "8.37.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.37.0.tgz", - "integrity": "sha512-zuWDMDuzMRbQOM+bHyU4/slw27bAUEcKSKKs3hcv2aNnc/tvE/h7w60dwVw8vnal2Pub6RT1T7BI8tFZ1fE+yg==", + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.38.0.tgz", + "integrity": "sha512-fooELKcAKzxux6fA6pxOflpNS0jc+nOQEEOipXFNjSlBS6fqrJOVY/whSn70SScHrcJ2LDsxWrneFoWYSVfqhQ==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/project-service": "8.37.0", - "@typescript-eslint/tsconfig-utils": "8.37.0", - "@typescript-eslint/types": "8.37.0", - "@typescript-eslint/visitor-keys": "8.37.0", + "@typescript-eslint/project-service": "8.38.0", + "@typescript-eslint/tsconfig-utils": "8.38.0", + "@typescript-eslint/types": "8.38.0", + "@typescript-eslint/visitor-keys": "8.38.0", "debug": "^4.3.4", "fast-glob": "^3.3.2", "is-glob": "^4.0.3", @@ -5248,16 +5250,16 @@ } }, "node_modules/@typescript-eslint/utils": { - "version": "8.37.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.37.0.tgz", - "integrity": "sha512-TSFvkIW6gGjN2p6zbXo20FzCABbyUAuq6tBvNRGsKdsSQ6a7rnV6ADfZ7f4iI3lIiXc4F4WWvtUfDw9CJ9pO5A==", + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.38.0.tgz", + "integrity": "sha512-hHcMA86Hgt+ijJlrD8fX0j1j8w4C92zue/8LOPAFioIno+W0+L7KqE8QZKCcPGc/92Vs9x36w/4MPTJhqXdyvg==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/eslint-utils": "^4.7.0", - "@typescript-eslint/scope-manager": "8.37.0", - "@typescript-eslint/types": "8.37.0", - "@typescript-eslint/typescript-estree": "8.37.0" + "@typescript-eslint/scope-manager": "8.38.0", + "@typescript-eslint/types": "8.38.0", + "@typescript-eslint/typescript-estree": "8.38.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -5272,13 +5274,13 @@ } }, "node_modules/@typescript-eslint/visitor-keys": { - "version": "8.37.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.37.0.tgz", - "integrity": "sha512-YzfhzcTnZVPiLfP/oeKtDp2evwvHLMe0LOy7oe+hb9KKIumLNohYS9Hgp1ifwpu42YWxhZE8yieggz6JpqO/1w==", + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.38.0.tgz", + "integrity": "sha512-pWrTcoFNWuwHlA9CvlfSsGWs14JxfN1TH25zM5L7o0pRLhsoZkDnTsXfQRJBEWJoV5DL0jf+Z+sxiud+K0mq1g==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.37.0", + "@typescript-eslint/types": "8.38.0", "eslint-visitor-keys": "^4.2.1" }, "engines": { @@ -6174,14 +6176,14 @@ "license": "MIT" }, "node_modules/axios": { - "version": "1.10.0", - "resolved": "https://registry.npmjs.org/axios/-/axios-1.10.0.tgz", - "integrity": "sha512-/1xYAC4MP/HEG+3duIhFr4ZQXR4sQXOIe+o6sdqzeykGLx6Upp/1p8MHqhINOvGeP7xyNHe7tsiJByc4SSVUxw==", + "version": "1.11.0", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.11.0.tgz", + "integrity": "sha512-1Lx3WLFQWm3ooKDYZD1eXmoGO9fxYQjrycfHFC8P0sCfQVXyROp0p9PFWBehewBOdCwHc+f/b8I0fMto5eSfwA==", "dev": true, "license": "MIT", "dependencies": { "follow-redirects": "^1.15.6", - "form-data": "^4.0.0", + "form-data": "^4.0.4", "proxy-from-env": "^1.1.0" } }, @@ -7137,9 +7139,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.5.185", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.185.tgz", - "integrity": "sha512-dYOZfUk57hSMPePoIQ1fZWl1Fkj+OshhEVuPacNKWzC1efe56OsHY3l/jCfiAgIICOU3VgOIdoq7ahg7r7n6MQ==", + "version": "1.5.190", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.190.tgz", + "integrity": "sha512-k4McmnB2091YIsdCgkS0fMVMPOJgxl93ltFzaryXqwip1AaxeDqKCGLxkXODDA5Ab/D+tV5EL5+aTx76RvLRxw==", "dev": true, "license": "ISC" }, @@ -7351,9 +7353,9 @@ } }, "node_modules/esbuild": { - "version": "0.25.6", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.6.tgz", - "integrity": "sha512-GVuzuUwtdsghE3ocJ9Bs8PNoF13HNQ5TXbEi2AhvVb8xU1Iwt9Fos9FEamfoee+u/TOsn7GUWc04lz46n2bbTg==", + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.8.tgz", + "integrity": "sha512-vVC0USHGtMi8+R4Kz8rt6JhEWLxsv9Rnu/lGYbPR8u47B+DCBksq9JarW0zOO7bs37hyOK1l2/oqtbciutL5+Q==", "dev": true, "hasInstallScript": true, "license": "MIT", @@ -7364,32 +7366,32 @@ "node": ">=18" }, "optionalDependencies": { - "@esbuild/aix-ppc64": "0.25.6", - "@esbuild/android-arm": "0.25.6", - "@esbuild/android-arm64": "0.25.6", - "@esbuild/android-x64": "0.25.6", - "@esbuild/darwin-arm64": "0.25.6", - "@esbuild/darwin-x64": "0.25.6", - "@esbuild/freebsd-arm64": "0.25.6", - "@esbuild/freebsd-x64": "0.25.6", - "@esbuild/linux-arm": "0.25.6", - "@esbuild/linux-arm64": "0.25.6", - "@esbuild/linux-ia32": "0.25.6", - "@esbuild/linux-loong64": "0.25.6", - "@esbuild/linux-mips64el": "0.25.6", - "@esbuild/linux-ppc64": "0.25.6", - "@esbuild/linux-riscv64": "0.25.6", - "@esbuild/linux-s390x": "0.25.6", - "@esbuild/linux-x64": "0.25.6", - "@esbuild/netbsd-arm64": "0.25.6", - "@esbuild/netbsd-x64": "0.25.6", - "@esbuild/openbsd-arm64": "0.25.6", - "@esbuild/openbsd-x64": "0.25.6", - "@esbuild/openharmony-arm64": "0.25.6", - "@esbuild/sunos-x64": "0.25.6", - "@esbuild/win32-arm64": "0.25.6", - "@esbuild/win32-ia32": "0.25.6", - "@esbuild/win32-x64": "0.25.6" + "@esbuild/aix-ppc64": "0.25.8", + "@esbuild/android-arm": "0.25.8", + "@esbuild/android-arm64": "0.25.8", + "@esbuild/android-x64": "0.25.8", + "@esbuild/darwin-arm64": "0.25.8", + "@esbuild/darwin-x64": "0.25.8", + "@esbuild/freebsd-arm64": "0.25.8", + "@esbuild/freebsd-x64": "0.25.8", + "@esbuild/linux-arm": "0.25.8", + "@esbuild/linux-arm64": "0.25.8", + "@esbuild/linux-ia32": "0.25.8", + "@esbuild/linux-loong64": "0.25.8", + "@esbuild/linux-mips64el": "0.25.8", + "@esbuild/linux-ppc64": "0.25.8", + "@esbuild/linux-riscv64": "0.25.8", + "@esbuild/linux-s390x": "0.25.8", + "@esbuild/linux-x64": "0.25.8", + "@esbuild/netbsd-arm64": "0.25.8", + "@esbuild/netbsd-x64": "0.25.8", + "@esbuild/openbsd-arm64": "0.25.8", + "@esbuild/openbsd-x64": "0.25.8", + "@esbuild/openharmony-arm64": "0.25.8", + "@esbuild/sunos-x64": "0.25.8", + "@esbuild/win32-arm64": "0.25.8", + "@esbuild/win32-ia32": "0.25.8", + "@esbuild/win32-x64": "0.25.8" } }, "node_modules/escalade": { @@ -8232,9 +8234,9 @@ } }, "node_modules/form-data": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.3.tgz", - "integrity": "sha512-qsITQPfmvMOSAdeyZ+12I1c+CKSstAFAwu+97zrnWAbIr5u8wfsExUzCesVLC8NgHuRUqNN4Zy6UPWUTRGslcA==", + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.4.tgz", + "integrity": "sha512-KrGhL9Q4zjj0kiUt5OO4Mr/A/jlI2jDYs5eHBpYHPcBEVSiipAvn2Ko2HnPe20rmcuuvMHNdZFp+4IlGTMF0Ow==", "dev": true, "license": "MIT", "dependencies": { @@ -10228,9 +10230,9 @@ } }, "node_modules/loupe": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.1.4.tgz", - "integrity": "sha512-wJzkKwJrheKtknCOKNEtDK4iqg/MxmZheEMtSTYvnzRdEYaZzmgH976nenp8WdJRdx5Vc1X/9MO0Oszl6ezeXg==", + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.2.0.tgz", + "integrity": "sha512-2NCfZcT5VGVNX9mSZIxLRkEAegDGBpuQZBy13desuHeVORmBDyAET4TkJr4SjqQy3A8JDofMN6LpkK8Xcm/dlw==", "dev": true, "license": "MIT" }, @@ -13646,16 +13648,16 @@ } }, "node_modules/typescript-eslint": { - "version": "8.37.0", - "resolved": "https://registry.npmjs.org/typescript-eslint/-/typescript-eslint-8.37.0.tgz", - "integrity": "sha512-TnbEjzkE9EmcO0Q2zM+GE8NQLItNAJpMmED1BdgoBMYNdqMhzlbqfdSwiRlAzEK2pA9UzVW0gzaaIzXWg2BjfA==", + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/typescript-eslint/-/typescript-eslint-8.38.0.tgz", + "integrity": "sha512-FsZlrYK6bPDGoLeZRuvx2v6qrM03I0U0SnfCLPs/XCCPCFD80xU9Pg09H/K+XFa68uJuZo7l/Xhs+eDRg2l3hg==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/eslint-plugin": "8.37.0", - "@typescript-eslint/parser": "8.37.0", - "@typescript-eslint/typescript-estree": "8.37.0", - "@typescript-eslint/utils": "8.37.0" + "@typescript-eslint/eslint-plugin": "8.38.0", + "@typescript-eslint/parser": "8.38.0", + "@typescript-eslint/typescript-estree": "8.38.0", + "@typescript-eslint/utils": "8.38.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -13888,15 +13890,15 @@ } }, "node_modules/vite": { - "version": "7.0.4", - "resolved": "https://registry.npmjs.org/vite/-/vite-7.0.4.tgz", - "integrity": "sha512-SkaSguuS7nnmV7mfJ8l81JGBFV7Gvzp8IzgE8A8t23+AxuNX61Q5H1Tpz5efduSN7NHC8nQXD3sKQKZAu5mNEA==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/vite/-/vite-7.0.6.tgz", + "integrity": "sha512-MHFiOENNBd+Bd9uvc8GEsIzdkn1JxMmEeYX35tI3fv0sJBUTfW5tQsoaOwuY4KhBI09A3dUJ/DXf2yxPVPUceg==", "dev": true, "license": "MIT", "dependencies": { "esbuild": "^0.25.0", "fdir": "^6.4.6", - "picomatch": "^4.0.2", + "picomatch": "^4.0.3", "postcss": "^8.5.6", "rollup": "^4.40.0", "tinyglobby": "^0.2.14" @@ -14644,9 +14646,9 @@ } }, "node_modules/zod": { - "version": "4.0.5", - "resolved": "https://registry.npmjs.org/zod/-/zod-4.0.5.tgz", - "integrity": "sha512-/5UuuRPStvHXu7RS+gmvRf4NXrNxpSllGwDnCBcJZtQsKrviYXm54yDGV2KYNLT5kq0lHGcl7lqWJLgSaG+tgA==", + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/zod/-/zod-4.0.8.tgz", + "integrity": "sha512-+MSh9cZU9r3QKlHqrgHMTSr3QwMGv4PLfR0M4N/sYWV5/x67HgXEhIGObdBkpnX8G78pTgWnIrBL2lZcNJOtfg==", "dev": true, "license": "MIT", "funding": { diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/main.tsp b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/main.tsp index ce77880456af..ac0951ac3c9c 100644 --- a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/main.tsp +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/main.tsp @@ -47,12 +47,6 @@ enum Versions { @useDependency(Azure.Core.Versions.v1_0_Preview_2) v2023_04_01: "2023-04-01", - /** - * The 2023-04-15-preview API version. - */ - @useDependency(Azure.Core.Versions.v1_0_Preview_2) - v2023_04_15_preview: "2023-04-15-preview", - /** * The 2024-11-15-preview API version. */ diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/models/common.tsp b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/models/common.tsp index 8bbadaa614fc..894345a404f8 100644 --- a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/models/common.tsp +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/models/common.tsp @@ -31,7 +31,7 @@ union ProjectKind { /** * A project to build conversation summarization models which are able to summarize long conversations. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) CustomConversationSummarization: "CustomConversationSummarization", } diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/models/project.tsp b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/models/project.tsp index e4667c202c20..82f7c2ba9ace 100644 --- a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/models/project.tsp +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/models/project.tsp @@ -75,7 +75,7 @@ model AnalyzeConversationAuthoringProjectMetadata { * The storage container name in case of conversation summarization. */ @visibility(Lifecycle.Create, Lifecycle.Read) - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) storageInputContainerName?: string; /** @@ -165,7 +165,7 @@ model AnalyzeConversationAuthoringCreateProjectOptions { /** * The storage container name in case of conversation summarization. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) storageInputContainerName?: string; /** @@ -192,7 +192,7 @@ model AnalyzeConversationAuthoringCreateProjectOptions { /** * Represents the options for authorizing a project copy to the current Azure resource. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("ConversationAuthoringCopyAuthorizationDetails", "csharp") model AnalyzeConversationAuthoringCopyAuthorizationOptions { /** @@ -214,7 +214,7 @@ model AnalyzeConversationAuthoringCopyAuthorizationOptions { /** * Represents the options for copying an existing project to another Azure resource. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("ConversationAuthoringCopyProjectDetails", "csharp") model AnalyzeConversationAuthoringCopiedProjectOptions { /** @@ -342,7 +342,7 @@ model AnalyzeConversationAuthoringEvaluationOptions { /** * Represents the state of a copy job. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("ConversationAuthoringCopyProjectState", "csharp") @resource("copy/jobs") @parentResource(AnalyzeConversationAuthoringProjectMetadata) @@ -457,7 +457,7 @@ model AnalyzeConversationAuthoringProjectDeployment { /** * Represents the metadata of the assigned Azure resources. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) assignedResources: AnalyzeConversationAuthoringDeploymentResource[]; } @@ -496,7 +496,7 @@ model AnalyzeConversationAuthoringCreateDeploymentOptions { /** * Represents the resource IDs to be assigned to the deployment. If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) @removed(Versions.v2025_05_15_preview) assignedResourceIds?: string[]; @@ -1055,7 +1055,7 @@ model AnalyzeConversationAuthoringLoadSnapshotJobState { /** * Represents the assigned deployment resources. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("ConversationAuthoringAssignedDeploymentResources", "csharp") model AnalyzeConversationAuthoringAssignedDeploymentResources { /** @@ -1072,7 +1072,7 @@ model AnalyzeConversationAuthoringAssignedDeploymentResources { /** * Represents the assigned deployment resource. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("ConversationAuthoringAssignedDeploymentResource", "csharp") @resource("resources") @parentResource(AnalyzeConversationAuthoringProjectMetadata) @@ -1094,7 +1094,7 @@ model AnalyzeConversationAuthoringAssignedDeploymentResource { /** * Represents the options for assigning Azure resources to a project. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("ConversationAuthoringAssignDeploymentResourcesDetails", "csharp") model AnalyzeConversationAuthoringAssignDeploymentResourcesOptions { /** @@ -1128,7 +1128,7 @@ model AnalyzeConversationAuthoringResourceMetadata { /** * Represents the options to unassign Azure resources from a project. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("ConversationAuthoringUnassignDeploymentResourcesDetails", "csharp") model AnalyzeConversationAuthoringUnassignDeploymentResourcesOptions { /** @@ -1140,7 +1140,7 @@ model AnalyzeConversationAuthoringUnassignDeploymentResourcesOptions { /** * Represents the state of a deployment resources job. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("ConversationAuthoringDeploymentResourcesState", "csharp") @resource("resources/assign/jobs") @parentResource(AnalyzeConversationAuthoringProjectMetadata) @@ -1261,7 +1261,7 @@ model AnalyzeConversationAuthoringProjectDeletionJobState { /** * Represents the metadata for deployments assigned to a resource. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName( "ConversationAuthoringAssignedResourceDeploymentsMetadata", "csharp" @@ -1281,7 +1281,7 @@ model AnalyzeConversationAuthoringAssignedResourceDeploymentsMetadata { /** * Represents the metadata for assigned deployments for a project. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("ConversationAuthoringAssignedProjectDeploymentsMetadata", "csharp") @resource("authoring/analyze-conversations/projects/global/deployments/resources") model AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata { @@ -1301,7 +1301,7 @@ model AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata { /** * Represents the metadata for an assigned deployment */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("ConversationAuthoringAssignedProjectDeploymentMetadata", "csharp") model AnalyzeConversationAuthoringAssignedProjectDeploymentMetadata { /** diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/routes.tsp b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/routes.tsp index aff5dd6f5a14..de65194f1972 100644 --- a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/routes.tsp +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/routes.tsp @@ -60,7 +60,7 @@ op conversationAuthoringListSupportedLanguages is languageOperations.ResourceLis */ #suppress "@azure-tools/typespec-azure-core/use-standard-names" @clientName("listAssignedResourceDeployments", "csharp") -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) op conversationAuthoringListAssignedResourceDeployments is languageOperations.ResourceList< AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata, ListQueryParametersTrait @@ -71,7 +71,7 @@ op conversationAuthoringListAssignedResourceDeployments is languageOperations.Re */ #suppress "@azure-tools/typespec-azure-core/use-standard-names" @clientName("listDeploymentResources", "csharp") -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) op conversationAuthoringListDeploymentResources is languageOperations.ResourceList< AnalyzeConversationAuthoringAssignedDeploymentResource, ListQueryParametersTrait @@ -207,7 +207,7 @@ interface ConversationAuthoringDeployment { @pollingOperation( ConversationAuthoringDeployment.getDeploymentDeleteFromResourcesStatus ) - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) deleteDeploymentFromResources is Foundations.LongRunningOperation< { /** @@ -238,7 +238,7 @@ interface ConversationAuthoringDeployment { /** * Gets the status of an existing delete deployment from specific resources job. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) getDeploymentDeleteFromResourcesStatus is languageOperations.ResourceRead; /** @@ -257,7 +257,7 @@ interface ConversationAuthoringProject { @pollingOperation( ConversationAuthoringProject.getAssignDeploymentResourcesStatus ) - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) assignDeploymentResources is Foundations.LongRunningOperation< { /** @@ -288,7 +288,7 @@ interface ConversationAuthoringProject { @pollingOperation( ConversationAuthoringProject.getUnassignDeploymentResourcesStatus ) - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) unassignDeploymentResources is Foundations.LongRunningOperation< { /** @@ -313,7 +313,7 @@ interface ConversationAuthoringProject { /** * Gets the status of an existing assign deployment resources job. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) getAssignDeploymentResourcesStatus is languageOperations.ResourceRead; /** @@ -322,7 +322,7 @@ interface ConversationAuthoringProject { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @route("/authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}") @get - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) getUnassignDeploymentResourcesStatus is Azure.Core.Foundations.Operation< { /** @@ -538,7 +538,7 @@ interface ConversationAuthoringProject { */ #suppress "@azure-tools/typespec-azure-core/casing-style" @post - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) @actionSeparator("/:") @action("authorize-copy") @clientName("AuthorizeProjectCopy", "csharp") @@ -555,7 +555,7 @@ interface ConversationAuthoringProject { @route("/authoring/analyze-conversations/projects/{projectName}/:copy") @post @pollingOperation(ConversationAuthoringProject.getCopyProjectStatus) - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) copyProject is Foundations.LongRunningOperation< { /** @@ -580,7 +580,7 @@ interface ConversationAuthoringProject { /** * Gets the status of an existing copy project job. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) getCopyProjectStatus is languageOperations.ResourceRead; /** @@ -738,7 +738,7 @@ interface ConversationAuthoringTrainedModel { @route("/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:evaluate") @post @pollingOperation(ConversationAuthoringTrainedModel.getEvaluationStatus) - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) evaluateModel is Foundations.LongRunningOperation< { /** @@ -795,7 +795,7 @@ interface ConversationAuthoringTrainedModel { /** * Gets the status for an evaluation job. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) getEvaluationStatus is languageOperations.ResourceRead; /** diff --git a/specification/cognitiveservices/Language.AnalyzeText-authoring/main.tsp b/specification/cognitiveservices/Language.AnalyzeText-authoring/main.tsp index 3d37944e963a..7437d612e873 100644 --- a/specification/cognitiveservices/Language.AnalyzeText-authoring/main.tsp +++ b/specification/cognitiveservices/Language.AnalyzeText-authoring/main.tsp @@ -49,12 +49,6 @@ enum Versions { @useDependency(Azure.Core.Versions.v1_0_Preview_2) v2023_04_01: "2023-04-01", - /** - * The 2023-04-15-preview API version. - */ - @useDependency(Azure.Core.Versions.v1_0_Preview_2) - v2023_04_15_preview: "2023-04-15-preview", - /** * The 2024-11-15-preview API version. */ diff --git a/specification/cognitiveservices/Language.AnalyzeText-authoring/models.tsp b/specification/cognitiveservices/Language.AnalyzeText-authoring/models.tsp index 75555fcd4774..3f455c60b492 100644 --- a/specification/cognitiveservices/Language.AnalyzeText-authoring/models.tsp +++ b/specification/cognitiveservices/Language.AnalyzeText-authoring/models.tsp @@ -35,19 +35,19 @@ union ProjectKind { /** * For building an abstractive summarization models which are able to summarize long documents. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) CustomAbstractiveSummarization: "CustomAbstractiveSummarization", /** * For building an text analytics for health model to identify your health domain data. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) CustomHealthcare: "CustomHealthcare", /** * For building a sentiment models which are able to extract sentiment for long documents. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) CustomTextSentiment: "CustomTextSentiment", } @@ -277,25 +277,25 @@ model TextAnalysisAuthoringProjectSettings { /** * The path to the AML connected project. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) amlProjectPath?: string; /** * Indicates whether the labeling experience can be modified or not. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) isLabelingLocked?: boolean; /** * Indicates whether to run GPT predictions or not. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) runGptPredictions?: boolean; /** * The predictive lookahead for GPT predictions that is specified by the user. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) gptPredictiveLookahead?: int32; } @@ -585,7 +585,7 @@ model TextAnalysisAuthoringEvaluationOptions { /** * Represents the state of a copy job. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("TextAuthoringCopyProjectState", "csharp") @resource("copy/jobs") @parentResource(TextAnalysisAuthoringProjectMetadata) @@ -700,7 +700,7 @@ model TextAnalysisAuthoringProjectDeployment { /** * Represents the metadata of the assigned Azure resources. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) assignedResources: TextAnalysisAuthoringDeploymentResource[]; } @@ -739,7 +739,7 @@ model TextAnalysisAuthoringCreateDeploymentOptions { /** * Represents the resource IDs to be assigned to the deployment. If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) @removed(Versions.v2025_05_15_preview) assignedResourceIds?: string[]; @@ -753,7 +753,7 @@ model TextAnalysisAuthoringCreateDeploymentOptions { /** * Represents the options for deleting a project deployment. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("TextAuthoringDeleteDeploymentDetails", "csharp") model TextAnalysisAuthoringDeleteDeploymentOptions { /** @@ -906,7 +906,7 @@ model TextAnalysisAuthoringExportedModelJobState { /** * Represents the properties for the exported model manifest. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("ExportedModelManifest", "csharp") model TextAnalysisAuthoringExportedModelManifest { /** @@ -919,7 +919,7 @@ model TextAnalysisAuthoringExportedModelManifest { * Represents the properties for the model file. */ @clientName("TextAuthoringModelFile", "csharp") -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) model TextAnalysisAuthoringModelFile { /** * The name of the file. @@ -1157,7 +1157,7 @@ model TextAnalysisAuthoringLoadSnapshotJobState { /** * Represents the assigned deployment resources. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("TextAuthoringAssignedDeploymentResources", "csharp") model TextAnalysisAuthoringAssignedDeploymentResources { /** @@ -1174,7 +1174,7 @@ model TextAnalysisAuthoringAssignedDeploymentResources { /** * Represents the assigned deployment resource. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("TextAuthoringAssignedDeploymentResource", "csharp") @resource("resources") @parentResource(TextAnalysisAuthoringProjectMetadata) @@ -1227,7 +1227,7 @@ model TextAnalysisAuthoringResourceMetadata { /** * Represents the options to unassign Azure resources from a project. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("TextAuthoringUnassignDeploymentResourcesDetails", "csharp") model TextAnalysisAuthoringUnassignDeploymentResourcesOptions { /** @@ -1239,7 +1239,7 @@ model TextAnalysisAuthoringUnassignDeploymentResourcesOptions { /** * Represents the state of a deployment resources job. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("TextAuthoringDeploymentResourcesState", "csharp") @resource("resources/assign/jobs") @parentResource(TextAnalysisAuthoringProjectMetadata) @@ -1350,7 +1350,7 @@ model TextAnalysisAuthoringProjectDeletionJobState { /** * Represents the metadata for deployments assigned to a resource. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("TextAuthoringAssignedResourceDeploymentsMetadata", "csharp") model TextAnalysisAuthoringAssignedResourceDeploymentsMetadata { /** @@ -1369,7 +1369,7 @@ model TextAnalysisAuthoringAssignedResourceDeploymentsMetadata { */ @resource("authoring/analyze-text/projects/global/deployments/resources") @clientName("TextAuthoringAssignedProjectDeploymentsMetadata", "csharp") -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) model TextAnalysisAuthoringAssignedProjectDeploymentsMetadata { /** * Represents the project name. @@ -1445,7 +1445,7 @@ model TextAnalysisAuthoringSupportedLanguage { /** * Represents a list of the retrieved supported prebuilt entities. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("TextAuthoringPrebuiltEntities", "csharp") model TextAnalysisAuthoringPrebuiltEntities { /** @@ -1462,7 +1462,7 @@ model TextAnalysisAuthoringPrebuiltEntities { /** * Represents a supported prebuilt entity. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @resource("authoring/analyze-text/projects/global/prebuilt-entities") @clientName("TextAuthoringPrebuiltEntity", "csharp") model TextAnalysisAuthoringPrebuiltEntity { @@ -1724,7 +1724,7 @@ model TextAnalysisAuthoringEntityEvaluationSummary { /** * Represents the document evaluation result for a custom entity recognition project. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("CustomHealthcareDocumentEvalResult", "csharp") model TextAnalysisAuthoringCustomHealthcareDocumentEvaluationResult extends TextAnalysisAuthoringDocumentEvaluationResult { @@ -1753,7 +1753,7 @@ model TextAnalysisAuthoringDocumentHealthcareEvaluationResult { /** * Represents the evaluation summary for a custom health care project. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("CustomHealthcareEvalSummary", "csharp") model TextAnalysisAuthoringCustomHealthcareEvaluationSummary extends TextAnalysisAuthoringEvaluationSummary { @@ -2040,7 +2040,7 @@ model TextAnalysisAuthoringSingleLabelClassEvaluationSummary { /** * Represents the document evaluation result for a custom sentiment project. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("CustomTextSentimentDocumentEvalResult", "csharp") model TextAnalysisAuthoringCustomTextSentimentDocumentEvaluationResult extends TextAnalysisAuthoringDocumentEvaluationResult { @@ -2095,7 +2095,7 @@ model TextAnalysisAuthoringDocumentSentimentLabelEvaluationResult { /** * Represents the evaluation summary for a custom text sentiment project. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("CustomTextSentimentEvalSummary", "csharp") model TextAnalysisAuthoringCustomTextSentimentEvaluationSummary extends TextAnalysisAuthoringEvaluationSummary { @@ -2358,7 +2358,7 @@ model TextAnalysisAuthoringExportedCustomAbstractiveSummarizationDocument { /** * Represents the exported assets for an abstractive summarization project. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("ExportedCustomAbstractiveSummarizationProjectAsset", "csharp") model TextAnalysisAuthoringExportedCustomAbstractiveSummarizationProjectAssets extends TextAnalysisAuthoringExportedProjectAssets { @@ -2509,7 +2509,7 @@ model TextAnalysisAuthoringExportedCustomHealthcareDocument { /** * Represents the exported assets for a CustomHealthcare project. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("ExportedCustomHealthcareProjectAsset", "csharp") model TextAnalysisAuthoringExportedCustomHealthcareProjectAssets extends TextAnalysisAuthoringExportedProjectAssets { @@ -2682,7 +2682,7 @@ model TextAnalysisAuthoringExportedDocumentSentimentLabel { /** * Represents the exported assets for a custom text sentiment project. */ -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) @clientName("CustomTextSentimentProjectAssets", "csharp") model TextAnalysisAuthoringExportedCustomTextSentimentProjectAssets extends TextAnalysisAuthoringExportedProjectAssets { diff --git a/specification/cognitiveservices/Language.AnalyzeText-authoring/routes.tsp b/specification/cognitiveservices/Language.AnalyzeText-authoring/routes.tsp index 3320890e709e..17f152a59305 100644 --- a/specification/cognitiveservices/Language.AnalyzeText-authoring/routes.tsp +++ b/specification/cognitiveservices/Language.AnalyzeText-authoring/routes.tsp @@ -48,7 +48,7 @@ op textAnalysisAuthoringListDeployments is languageOperations.ResourceList< */ #suppress "@azure-tools/typespec-azure-core/use-standard-names" @clientName("listExportedModels", "csharp") -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) op textAnalysisAuthoringListExportedModels is languageOperations.ResourceList< TextAnalysisAuthoringExportedTrainedModel, ListQueryParametersTrait @@ -69,7 +69,7 @@ op textAnalysisAuthoringListTrainedModels is languageOperations.ResourceList< */ #suppress "@azure-tools/typespec-azure-core/use-standard-names" @clientName("listDeploymentResources", "csharp") -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) op textAnalysisAuthoringListDeploymentResources is languageOperations.ResourceList< TextAnalysisAuthoringAssignedDeploymentResource, ListQueryParametersTrait @@ -90,7 +90,7 @@ op textAnalysisAuthoringListTrainingJobs is languageOperations.ResourceList< */ #suppress "@azure-tools/typespec-azure-core/use-standard-names" @clientName("listAssignedResourceDeployments", "csharp") -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) op textAnalysisAuthoringListAssignedResourceDeployments is languageOperations.ResourceList< TextAnalysisAuthoringAssignedProjectDeploymentsMetadata, ListQueryParametersTrait @@ -112,7 +112,7 @@ op textAnalysisAuthoringGetSupportedLanguages is languageOperations.ResourceList */ #suppress "@azure-tools/typespec-azure-core/use-standard-names" "Existing name" @clientName("getSupportedPrebuiltEntities", "csharp") -@added(Versions.v2023_04_15_preview) +@added(Versions.v2024_11_15_preview) op textAnalysisAuthoringGetSupportedPrebuiltEntities is languageOperations.ResourceList< TextAnalysisAuthoringPrebuiltEntity, SupportedPrebuiltEntitiesQueryParameter & StandardListQueryParameters @@ -187,7 +187,7 @@ interface TextAuthoringProject { * Generates a copy project operation authorization to the current target Azure resource. */ #suppress "@azure-tools/typespec-azure-core/documentation-required" - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) @actionSeparator("/:") @action("authorize-copy") @clientName("AuthorizeProjectCopy", "csharp") @@ -204,7 +204,7 @@ interface TextAuthoringProject { @route("/authoring/analyze-text/projects/{projectName}/:copy") @post @pollingOperation(TextAuthoringProject.getCopyProjectStatus) - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) copyProject is Foundations.LongRunningOperation< { /** @@ -280,7 +280,7 @@ interface TextAuthoringProject { /** * The format of the project to import. The currently supported formats are json and aml formats. If not provided, the default is set to json. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) @header format?: string; @@ -324,7 +324,7 @@ interface TextAuthoringProject { /** * Gets the status of an existing copy project job. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) getCopyProjectStatus is languageOperations.ResourceRead; /** @@ -370,7 +370,7 @@ interface TextAuthoringProject { @route("/authoring/analyze-text/projects/{projectName}/resources/:unassign") @post @pollingOperation(TextAuthoringProject.getUnassignDeploymentResourcesStatus) - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) unassignDeploymentResources is Foundations.LongRunningOperation< { /** @@ -396,7 +396,7 @@ interface TextAuthoringProject { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @route("/authoring/analyze-text/projects/{projectName}/resources/unassign/jobs/{jobId}") @get - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) getUnassignDeploymentResourcesStatus is Azure.Core.Foundations.Operation< { /** @@ -423,7 +423,7 @@ interface TextAuthoringProject { @route("/authoring/analyze-text/projects/{projectName}/resources/:assign") @post @pollingOperation(TextAuthoringProject.getAssignDeploymentResourcesStatus) - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) assignDeploymentResources is Foundations.LongRunningOperation< { /** @@ -446,7 +446,7 @@ interface TextAuthoringProject { /** * Gets the status of an existing assign deployment resources job. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) getAssignDeploymentResourcesStatus is languageOperations.ResourceRead; /** @@ -522,7 +522,7 @@ interface TextAuthoringDeployment { @pollingOperation( TextAuthoringDeployment.getDeploymentDeleteFromResourcesStatus ) - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) deleteDeploymentFromResources is Foundations.LongRunningOperation< { /** @@ -551,7 +551,7 @@ interface TextAuthoringDeployment { /** * Gets the status of an existing delete deployment from specific resources job. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) getDeploymentDeleteFromResourcesStatus is languageOperations.ResourceRead; /** @@ -596,7 +596,7 @@ interface TextAuthoringExportedModel { /** * Gets the details of an exported model. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) getExportedModel is languageOperations.ResourceRead; /** @@ -606,7 +606,7 @@ interface TextAuthoringExportedModel { @route("/authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}") @put @pollingOperation(TextAuthoringExportedModel.getExportedModelJobStatus) - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) createOrUpdateExportedModel is Foundations.LongRunningOperation< { /** @@ -639,7 +639,7 @@ interface TextAuthoringExportedModel { @route("/authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}") @delete @pollingOperation(TextAuthoringExportedModel.getExportedModelJobStatus) - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) deleteExportedModel is Foundations.LongRunningOperation< { /** @@ -662,7 +662,7 @@ interface TextAuthoringExportedModel { /** * Gets the status for an existing job to create or update an exported model. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) getExportedModelJobStatus is languageOperations.ResourceRead; /** @@ -671,7 +671,7 @@ interface TextAuthoringExportedModel { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @route("/authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}/manifest") @get - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) getExportedModelManifest is Azure.Core.Foundations.Operation< { /** @@ -710,7 +710,7 @@ interface TextAuthoringTrainedModel { @route("/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/:evaluate") @post @pollingOperation(TextAuthoringTrainedModel.getEvaluationStatus) - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) evaluateModel is Foundations.LongRunningOperation< { /** @@ -762,7 +762,7 @@ interface TextAuthoringTrainedModel { /** * Gets the status for an evaluation job. */ - @added(Versions.v2023_04_15_preview) + @added(Versions.v2024_11_15_preview) getEvaluationStatus is languageOperations.ResourceRead; /** diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/common.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/common.json deleted file mode 100644 index 27ee0a9afea2..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/common.json +++ /dev/null @@ -1,206 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2021-05-01-preview" - }, - "paths": {}, - "definitions": { - "ErrorResponse": { - "type": "object", - "description": "Error response.", - "additionalProperties": false, - "properties": { - "error": { - "description": "The error object.", - "$ref": "#/definitions/Error" - } - } - }, - "Error": { - "type": "object", - "description": "The error object.", - "additionalProperties": false, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/ErrorCode" - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - }, - "target": { - "type": "string", - "description": "The target of the error." - }, - "details": { - "type": "array", - "description": "An array of details about specific errors that led to this reported error.", - "items": { - "$ref": "#/definitions/Error" - } - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "InnerErrorModel": { - "type": "object", - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", - "additionalProperties": false, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/InnerErrorCode" - }, - "message": { - "type": "string", - "description": "Error message." - }, - "details": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Error details." - }, - "target": { - "type": "string", - "description": "Error target." - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "ErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "ErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidArgument", - "Unauthorized", - "Forbidden", - "NotFound", - "TooManyRequests", - "InternalServerError", - "ServiceUnavailable" - ] - }, - "InnerErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "InnerErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidParameterValue", - "KnowledgeBaseNotFound", - "AzureCognitiveSearchNotFound", - "AzureCognitiveSearchThrottling", - "ExtractionFailure" - ] - }, - "Language": { - "type": "string", - "description": "Language of the text records. This is BCP-47 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." - }, - "StringIndexType": { - "type": "string", - "description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.", - "default": "TextElements_v8", - "enum": [ - "TextElements_v8", - "UnicodeCodePoint", - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "TextElements_v8", - "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." - }, - { - "value": "UnicodeCodePoint", - "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." - }, - { - "value": "Utf16CodeUnit", - "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - } - } - }, - "parameters": { - "Endpoint": { - "name": "Endpoint", - "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - "ProjectNameQueryParameter": { - "name": "projectName", - "in": "query", - "required": true, - "type": "string", - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "ProjectNamePathParameter": { - "name": "projectName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNameQueryParameter": { - "name": "deploymentName", - "in": "query", - "required": false, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNamePathParameter": { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json deleted file mode 100644 index 2ade3b74bc59..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json +++ /dev/null @@ -1,93 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1", - "deploymentName": "production", - "knowledgeBaseQueryOptions": { - "question": "how long it takes to charge surface?", - "top": 3, - "userId": "sd53lsY=", - "confidenceScoreThreshold": 0.20, - "context": { - "previousQnaId": 9, - "previousUserQuery": "Where are QnA Maker quickstarts?" - }, - "rankerType": "Default", - "strictFilters": { - "metadataFilter": { - "metadata": { - "category": "api", - "editorial": "chitchat" - }, - "compoundOperation": "AND" - }, - "sourceFilter": [ - "filename1.pdf", - "https://www.wikipedia.org/microsoft" - ], - "compoundOperation": "AND" - }, - "answerSpanRequest": { - "enable": true, - "confidenceScoreThreshold": 0.20, - "topAnswersWithSpan": 1 - }, - "includeUnstructuredSources": true - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "answers": [ - { - "questions": [ - "Power and charging" - ], - "answer": "Power and charging**\n\nIt takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.\n\nYou can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface.", - "confidenceScore": 0.65, - "id": 20, - "source": "surface-pro-4-user-guide-EN.pdf", - "metadata": { - "category": "api", - "editorial": "chitchat" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 23, - "displayText": "prompt1" - }, - { - "displayOrder": 2, - "qnaId": 36, - "displayText": "prompt2" - } - ] - }, - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0.30, - "offset": 33, - "length": 50 - } - }, - { - "questions": [ - "Charge your Surface Pro 4" - ], - "answer": "**Charge your Surface Pro 4**\n\n1. Connect the two parts of the power cord.\n\n2. Connect the power cord securely to the charging port.\n\n3. Plug the power supply into an electrical outlet.", - "confidenceScore": 0.32, - "id": 13, - "source": "surface-pro-4-user-guide-EN.pdf" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/SuccessfulQueryText.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/SuccessfulQueryText.json deleted file mode 100644 index cbee2df2b818..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/SuccessfulQueryText.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "stringIndexType": "TextElements_v8", - "textQueryOptions": { - "question": "how long it takes to charge surface?", - "records": [ - { - "id": "1", - "text": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it." - }, - { - "id": "2", - "text": "You can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface." - } - ], - "language": "en" - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "answers": [ - { - "answer": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", - "confidenceScore": 0.93, - "id": "1", - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0, - "offset": 28, - "length": 45 - }, - "offset": 0, - "length": 224 - }, - { - "answer": "It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", - "confidenceScore": 0.92, - "id": "1", - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0, - "offset": 8, - "length": 25 - }, - "offset": 20, - "length": 224 - }, - { - "answer": "It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", - "confidenceScore": 0.05, - "id": "1", - "answerSpan": null, - "offset": 110, - "length": 244 - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json deleted file mode 100644 index 8becc6b34a12..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1", - "body": { - "projectName": "proj1 friendly name", - "description": "proj1 is a test project.", - "language": "en", - "defaultAnswer": "No good match found for your question in the Knowledgebase.", - "multilingualResource": true - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "defaultAnswer": "No good match found for your question in the Knowledgebase.", - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - }, - "201": { - "headers": {}, - "body": { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "defaultAnswer": "No good match found for your question in the Knowledgebase.", - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json deleted file mode 100644 index ee1a7d65997d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1" - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulGetProject.json deleted file mode 100644 index 3d16fb5b5e7b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulGetProject.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "defaultAnswer": "No good match found for your question in the Knowledgebase.", - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json deleted file mode 100644 index a7dccc1a4deb..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "qnas": [ - { - "id": 1, - "answer": "ans1", - "source": "source1", - "questions": [ - "question 1.1", - "question 1.2" - ], - "metadata": { - "k1": "v1", - "k2": "v2" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 11, - "displayText": "prompt 1.1" - }, - { - "displayOrder": 2, - "qnaId": 21, - "displayText": "prompt 1.2" - } - ] - }, - "lastUpdatedDateTime": "2021-05-01T17:21:14Z" - }, - { - "id": 2, - "answer": "ans2", - "source": "source2", - "questions": [ - "question 2.1", - "question 2.2" - ], - "lastUpdatedDateTime": "2021-05-01T17:21:14Z" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulGetSources.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulGetSources.json deleted file mode 100644 index c3de6f4f8f3e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulGetSources.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "sources": [ - { - "sourceName": "source1", - "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview", - "sourceKind": "url", - "lastUpdatedDateTime": "2021-05-01T15:13:22Z" - }, - { - "sourceName": "source2", - "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf", - "sourceKind": "file", - "contentStructureKind": "unstructured", - "lastUpdatedDateTime": "2021-05-01T15:13:22Z" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json deleted file mode 100644 index dea42d20a92a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "synonyms": [ - { - "alterations": [ - "qnamaker", - "qna maker" - ] - }, - { - "alterations": [ - "botframework", - "bot framework" - ] - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json deleted file mode 100644 index 6dca7a44488a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1", - "deploymentName": "production", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "Succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json deleted file mode 100644 index 01e125fd8f5b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "Succeeded", - "resultUrl": "https:///language/proj1/export/job1/result" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json deleted file mode 100644 index bdf8d52aae46..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "Succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json deleted file mode 100644 index db744178be39..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1", - "deploymentName": "production" - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "job1" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json deleted file mode 100644 index b81f8444fc7f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1", - "body": { - "exportAssetTypes": [ - "qnas", - "synonyms" - ] - } - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "job1" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json deleted file mode 100644 index c295040b3942..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json +++ /dev/null @@ -1,78 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1", - "body": { - "assets": { - "synonyms": [ - { - "alterations": [ - "wa", - "washington", - "washington state" - ] - }, - { - "alterations": [ - "U.S", - "usa", - "united states of america" - ] - } - ], - "qnas": [ - { - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "id": 1, - "answer": "ans1", - "source": "source1", - "questions": [ - "question 1.1", - "question 1.2" - ], - "metadata": { - "k1": "v1", - "k2": "v2" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 11, - "displayText": "prompt 1.1" - }, - { - "displayOrder": 2, - "qnaId": 21, - "displayText": "prompt 1.2" - } - ] - } - }, - { - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "id": 2, - "answer": "ans2", - "source": "source2", - "questions": [ - "question 2.1", - "question 2.2" - ] - } - ] - } - } - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "job1" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json deleted file mode 100644 index ad33e5f3ea30..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "projects": [ - { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - }, - { - "projectName": "proj2", - "description": "proj2 is a test project.", - "language": "fr", - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json deleted file mode 100644 index 5661696e1dad..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1", - "body": [ - { - "op": "add", - "value": { - "id": 3, - "answer": "ans3", - "source": "source1", - "questions": [ - "question 3.1", - "question 3.2" - ], - "metadata": { - "k1": "v1", - "k2": "v2" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 11, - "displayText": "prompt 3.1" - }, - { - "displayOrder": 2, - "qnaId": 21, - "displayText": "prompt 3.2" - } - ] - } - } - }, - { - "op": "replace", - "value": { - "id": 1, - "answer": "ans4", - "source": "source1", - "questions": [ - "question 4.1", - "question 4.2" - ] - } - }, - { - "op": "delete", - "value": { - "id": 2, - "answer": "ans2", - "source": "source1", - "questions": [ - "question 2.1", - "question 2.2" - ] - } - } - ] - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "job1" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json deleted file mode 100644 index bdf8d52aae46..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "Succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json deleted file mode 100644 index b3b6bc7f3932..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1", - "body": [ - { - "op": "add", - "value": { - "sourceName": "source3", - "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context", - "sourceKind": "url" - } - }, - { - "op": "replace", - "value": { - "sourceName": "source1", - "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview", - "sourceKind": "url" - } - }, - { - "op": "delete", - "value": { - "sourceName": "source2", - "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf", - "sourceKind": "file" - } - } - ] - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "job1" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json deleted file mode 100644 index bdf8d52aae46..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "Succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json deleted file mode 100644 index cea703d84756..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-05-01-preview", - "projectName": "proj1", - "body": { - "synonyms": [ - { - "alterations": [ - "qnamaker", - "qna maker" - ] - }, - { - "alterations": [ - "botframework", - "bot framework" - ] - } - ] - } - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/questionanswering-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/questionanswering-authoring.json deleted file mode 100644 index 17331966623a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/questionanswering-authoring.json +++ /dev/null @@ -1,1438 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Question Answering - Authoring", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2021-05-01-preview" - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/query-knowledgebases/projects": { - "get": { - "summary": "Gets all projects for a user.", - "operationId": "QuestionAnsweringProjects_ListProjects", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": null, - "itemName": "projects" - }, - "responses": { - "200": { - "description": "The metadata of all projects.", - "schema": { - "$ref": "#/definitions/ProjectsMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectsListProjects.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}": { - "get": { - "summary": "Get the requested project metadata.", - "operationId": "QuestionAnsweringProjects_GetProjectDetails", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The metadata for the specified project.", - "schema": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetProject.json" - } - } - }, - "put": { - "summary": "Create or update a project.", - "operationId": "QuestionAnsweringProjects_CreateProject", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "description": "Parameters needed to create the project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CreateProjectOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The metadata of the updated project, if it already exists.", - "schema": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "201": { - "description": "The metadata of the created project, if it doesn't exist.", - "schema": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulCreateProject.json" - } - } - }, - "delete": { - "summary": "Delete the project.", - "operationId": "QuestionAnsweringProjects_DeleteProject", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "204": { - "description": "Project deleted successfully." - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulDeleteProject.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/:export": { - "post": { - "summary": "Export project metadata and assets.", - "operationId": "QuestionAnsweringProjects_Export", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ImportExportFormatParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/export/jobs/{jobId}": { - "get": { - "summary": "Gets the status of an Export job, once job completes, returns the project metadata, and assets.", - "operationId": "QuestionAnsweringProjects_GetExportStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Export job status, project metadata, and assets.", - "schema": { - "$ref": "#/definitions/ExportJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/:import": { - "post": { - "summary": "Import project assets.", - "operationId": "QuestionAnsweringProjects_Import", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Project assets the needs to be imported.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/ImportJobOptions" - } - }, - { - "$ref": "#/parameters/ImportExportFormatParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/import/jobs/{jobId}": { - "get": { - "summary": "Gets the status of an Import job.", - "operationId": "QuestionAnsweringProjects_GetImportStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Import job status.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}": { - "put": { - "summary": "Deploy project to production.", - "operationId": "QuestionAnsweringProjects_DeployProject", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { - "get": { - "summary": "Gets the status of a Deploy job.", - "operationId": "QuestionAnsweringProjects_GetDeployStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Deploy job state.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/synonyms": { - "get": { - "summary": "Gets all the synonyms of a project.", - "operationId": "QuestionAnsweringProjects_GetSynonyms", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "All the synonyms of a project.", - "schema": { - "$ref": "#/definitions/SynonymAssets" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetSynonyms.json" - } - } - }, - "put": { - "summary": "Updates all the synonyms of a project.", - "operationId": "QuestionAnsweringProjects_UpdateSynonyms", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "All the synonyms of a project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SynonymAssets" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "204": { - "description": "Synonyms update successfully." - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/sources": { - "get": { - "summary": "Gets all the sources of a project.", - "operationId": "QuestionAnsweringProjects_GetSources", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": null, - "itemName": "sources" - }, - "responses": { - "200": { - "description": "All the sources of a project.", - "schema": { - "$ref": "#/definitions/QnaSources" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetSources.json" - } - } - }, - "patch": { - "summary": "Updates the sources of a project.", - "operationId": "QuestionAnsweringProjects_UpdateSources", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Update sources parameters of a project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateSourcesOptions" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSources.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/sources/jobs/{jobId}": { - "get": { - "summary": "Gets the status of update sources job.", - "operationId": "QuestionAnsweringProjects_GetUpdateSourcesStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Update sources job state.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/qnas": { - "get": { - "summary": "Gets all the QnAs of a project.", - "operationId": "QuestionAnsweringProjects_GetQnas", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SourceFilterParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": null, - "itemName": "qnas" - }, - "responses": { - "200": { - "description": "All the QnAs of a project.", - "schema": { - "$ref": "#/definitions/QnaAssets" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetQnas.json" - } - } - }, - "patch": { - "summary": "Updates the QnAs of a project.", - "operationId": "QuestionAnsweringProjects_UpdateQnas", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Update QnAs parameters of a project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateQnaOptions" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateQnas.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/qnas/jobs/{jobId}": { - "get": { - "summary": "Gets the status of update QnAs job.", - "operationId": "QuestionAnsweringProjects_GetUpdateQnasStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Update QnAs job state.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json" - } - } - } - } - }, - "definitions": { - "ProjectsMetadata": { - "type": "object", - "description": "Collection of projects metadata and global settings.", - "additionalProperties": false, - "properties": { - "projects": { - "type": "array", - "items": { - "$ref": "#/definitions/ProjectMetadata" - } - } - } - }, - "ProjectMetadata": { - "type": "object", - "description": "Represents the project.", - "additionalProperties": false, - "properties": { - "projectName": { - "type": "string", - "description": "Name of the project." - }, - "description": { - "type": "string", - "description": "Description of the project." - }, - "language": { - "$ref": "common.json#/definitions/Language" - }, - "defaultAnswer": { - "type": "string", - "description": "Default Answer response when no good match is found in the knowledge base." - }, - "multilingualResource": { - "type": "boolean", - "description": "Resource enabled for multiple languages across projects or not." - }, - "enableHierarchicalExtraction": { - "type": "boolean", - "description": "Resource enabled for hierarchical QnA extraction from sources." - }, - "defaultAnswerUsedForExtraction": { - "type": "string", - "description": "Default answer to be used during QnA extraction from sources." - }, - "createdDateTime": { - "type": "string", - "description": "Project creation date-time.", - "format": "date-time" - }, - "lastModifiedDateTime": { - "type": "string", - "description": "Represents the project last modified date-time.", - "format": "date-time" - }, - "lastDeployedDateTime": { - "type": "string", - "description": "Represents the project last deployment date-time.", - "format": "date-time" - } - } - }, - "CreateProjectOptions": { - "type": "object", - "description": "Parameters needed to create the project.", - "additionalProperties": false, - "required": [ - "projectName", - "language" - ], - "properties": { - "projectName": { - "type": "string", - "description": "Friendly name for the project." - }, - "description": { - "type": "string", - "description": "Description of the project." - }, - "language": { - "$ref": "common.json#/definitions/Language" - }, - "defaultAnswer": { - "type": "string", - "description": "Default Answer response when no good match is found in the knowledge base." - }, - "multilingualResource": { - "type": "boolean", - "description": "Set to true to enable creating knowledgebases in different languages for the same resource." - }, - "enableHierarchicalExtraction": { - "type": "boolean", - "description": "Resource enabled for hierarchical QnA extraction from sources." - }, - "defaultAnswerUsedForExtraction": { - "type": "string", - "description": "Default answer to be used during QnA extraction from sources." - } - } - }, - "ExportJobOptions": { - "type": "object", - "description": "Parameters required for export project job.", - "additionalProperties": false, - "properties": { - "exportAssetTypes": { - "$ref": "#/definitions/AssetTypes" - } - } - }, - "ImportJobOptions": { - "type": "object", - "description": "Project assets the needs to be imported.", - "additionalProperties": false, - "properties": { - "projectMetadata": { - "$ref": "#/definitions/CreateProjectOptions" - }, - "assets": { - "$ref": "#/definitions/Assets" - }, - "fileUri": { - "type": "string", - "description": "Import data File URI." - } - } - }, - "AssetTypes": { - "type": "array", - "description": "Collection of asset types.", - "items": { - "$ref": "#/definitions/AssetKind" - } - }, - "AssetKind": { - "type": "string", - "description": "Asset types for the project.", - "x-ms-enum": { - "name": "assetKind", - "modelAsString": true - }, - "enum": [ - "synonyms", - "qnas" - ] - }, - "JobMetadata": { - "description": "Represents the job metadata.", - "properties": { - "createdDateTime": { - "format": "date-time", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "type": "string" - }, - "jobId": { - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { - "$ref": "#/definitions/JobStatus" - } - }, - "required": [ - "jobId", - "lastUpdatedDateTime", - "createdDateTime", - "status" - ], - "type": "object" - }, - "JobStatus": { - "description": "Job Status.", - "enum": [ - "NotStarted", - "Running", - "Succeeded", - "Failed", - "Cancelled", - "Cancelling", - "PartiallyCompleted" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "jobStatus" - } - }, - "JobState": { - "description": "Job state represents the job metadata and any errors.", - "allOf": [ - { - "$ref": "#/definitions/JobMetadata" - }, - { - "$ref": "#/definitions/Errors" - } - ] - }, - "Errors": { - "description": "Collection of Error types.", - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - } - } - }, - "ExportJobState": { - "description": "Export job status, project metadata, and assets.", - "allOf": [ - { - "$ref": "#/definitions/JobState" - }, - { - "$ref": "#/definitions/ExportJobResultUrl" - } - ] - }, - "ExportJobResultUrl": { - "type": "object", - "description": "URL to download the result of the Export Job.", - "required": [ - "resultUrl" - ], - "properties": { - "resultUrl": { - "type": "string", - "description": "URL to download the result of the Export Job." - } - } - }, - "Assets": { - "type": "object", - "description": "All assets for this project.", - "additionalProperties": false, - "properties": { - "synonyms": { - "$ref": "#/definitions/SynonymAsset" - }, - "qnas": { - "$ref": "#/definitions/QnaAsset" - } - } - }, - "SynonymAssets": { - "type": "object", - "description": "All synonym assets for this project.", - "additionalProperties": false, - "properties": { - "synonyms": { - "$ref": "#/definitions/SynonymAsset" - } - } - }, - "SynonymAsset": { - "type": "array", - "description": "Collection of synonyms.", - "additionalProperties": false, - "maxLength": 10000, - "items": { - "$ref": "#/definitions/WordAlterations" - } - }, - "WordAlterations": { - "type": "object", - "description": "Collection of word alterations.", - "additionalProperties": false, - "required": [ - "alterations" - ], - "properties": { - "alterations": { - "type": "array", - "description": "Collection of word alterations.", - "maxLength": 20, - "items": { - "type": "string" - } - } - } - }, - "QnaAssets": { - "type": "object", - "description": "All QnA assets for the project.", - "additionalProperties": false, - "properties": { - "qnas": { - "$ref": "#/definitions/QnaAsset" - } - } - }, - "QnaAsset": { - "type": "array", - "description": "List of QnA records.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/RetrieveQnaRecord" - } - }, - "QnaRecord": { - "type": "object", - "description": "QnA record.", - "additionalProperties": false, - "properties": { - "id": { - "type": "integer", - "description": "Unique ID for the QnA.", - "format": "int32" - }, - "answer": { - "type": "string", - "description": "Answer text.", - "maxLength": 25000, - "minLength": 1 - }, - "source": { - "type": "string", - "description": "Source from which QnA was indexed e.g. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .", - "maxLength": 300 - }, - "questions": { - "type": "array", - "description": "List of questions associated with the answer.", - "maxLength": 100, - "minLength": 1, - "items": { - "type": "string" - } - }, - "metadata": { - "type": "object", - "description": "Metadata associated with the answer, useful to categorize or filter question answers.", - "additionalProperties": { - "type": "string" - } - }, - "dialog": { - "description": "Context of a QnA.", - "$ref": "#/definitions/QnaDialog" - } - } - }, - "RetrieveQnaRecord": { - "description": "QnA Record with last updated date-time.", - "allOf": [ - { - "$ref": "#/definitions/QnaRecord" - }, - { - "$ref": "#/definitions/LastUpdatedDateTimeParameter" - } - ] - }, - "LastUpdatedDateTimeParameter": { - "type": "object", - "description": "Last updated date-time parameter.", - "properties": { - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "Date-time when the QnA was last updated." - } - } - }, - "QnaDialog": { - "type": "object", - "description": "Dialog associated with QnA Record.", - "properties": { - "isContextOnly": { - "type": "boolean", - "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as search result for queries without context; otherwise, ignores context and includes this QnA in search result." - }, - "prompts": { - "type": "array", - "description": "List of prompts associated with the answer.", - "maxItems": 20, - "items": { - "$ref": "#/definitions/QnaPrompt" - } - } - } - }, - "QnaPrompt": { - "type": "object", - "description": "Prompt for an answer.", - "properties": { - "displayOrder": { - "type": "integer", - "description": "Index of the prompt. It is used for ordering of the prompts.", - "format": "int32" - }, - "qnaId": { - "type": "integer", - "description": "ID of the QnA corresponding to the prompt.", - "format": "int32" - }, - "qna": { - "description": "QnA record. Either QnAId or QnA record needs to be present in a Prompt.", - "$ref": "#/definitions/QnaRecord" - }, - "displayText": { - "type": "string", - "description": "Text displayed to represent a follow up question prompt.", - "maxLength": 200 - } - } - }, - "UpdateOperationKind": { - "type": "string", - "description": "Update operation type for assets.", - "enum": [ - "add", - "delete", - "replace" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "updateOperationKind" - } - }, - "UpdateSourcesOptions": { - "type": "array", - "description": "A list of sources to be updated.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/UpdateSourceRecord" - } - }, - "UpdateQnaOptions": { - "type": "array", - "description": "A list of QnAs to be updated.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/UpdateQnaRecord" - } - }, - "UpdateQnaRecord": { - "type": "object", - "description": "QnA record to be updated.", - "additionalProperties": false, - "required": [ - "op", - "value" - ], - "properties": { - "op": { - "type": "string", - "$ref": "#/definitions/UpdateOperationKind" - }, - "value": { - "$ref": "#/definitions/QnaRecord" - } - } - }, - "UpdateSourceRecord": { - "type": "object", - "description": "Source to be updated.", - "additionalProperties": false, - "required": [ - "op", - "value" - ], - "properties": { - "op": { - "type": "string", - "$ref": "#/definitions/UpdateOperationKind" - }, - "value": { - "$ref": "#/definitions/QnaSourceMetadata" - } - } - }, - "QnaSources": { - "type": "object", - "description": "All QnA sources for the project.", - "additionalProperties": false, - "properties": { - "sources": { - "$ref": "#/definitions/QnaSourcesMetadata" - } - } - }, - "QnaSourcesMetadata": { - "type": "array", - "description": "Custom sources from which QnAs were extracted or explicitly added to the project.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/QnaSourceRecord" - } - }, - "QnaSourceRecord": { - "description": "Custom source record with last updated date-time.", - "allOf": [ - { - "$ref": "#/definitions/QnaSourceMetadata" - }, - { - "$ref": "#/definitions/LastUpdatedDateTimeParameter" - } - ] - }, - "QnaSourceMetadata": { - "type": "object", - "description": "Input source file or url details.", - "additionalProperties": false, - "required": [ - "sourceUri", - "sourceKind" - ], - "properties": { - "sourceName": { - "type": "string", - "description": "Friendly name of the Source.", - "maxLength": 200, - "minLength": 1 - }, - "source": { - "type": "string", - "description": "Unique source identifier." - }, - "sourceUri": { - "type": "string", - "description": "URI location for the file or url.", - "format": "uri" - }, - "sourceKind": { - "type": "string", - "$ref": "#/definitions/QnaSourceKind", - "default": "url" - }, - "contentStructureKind": { - "type": "string", - "$ref": "#/definitions/SourceContentStructureKind", - "default": "Unstructured" - } - } - }, - "QnaSourceKind": { - "type": "string", - "description": "Supported source types.", - "x-ms-enum": { - "name": "sourceKind", - "modelAsString": true - }, - "enum": [ - "file", - "url" - ] - }, - "SourceContentStructureKind": { - "type": "string", - "description": "Content structure type for sources.", - "enum": [ - "unstructured" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "sourceContentStructureKind" - } - } - }, - "parameters": { - "JobIdParameter": { - "name": "jobId", - "in": "path", - "description": "Job ID.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ImportExportFormatParameter": { - "name": "format", - "type": "string", - "in": "query", - "description": "Knowledge base Import or Export format.", - "default": "json", - "enum": [ - "json", - "tsv", - "excel" - ], - "x-ms-enum": { - "name": "format", - "modelAsString": true, - "values": [ - { - "value": "json", - "description": "Export or Import QnA assets in JSON format." - }, - { - "value": "tsv", - "description": "Export or Import knowledge base replica including all assets and metadata in Excel format." - }, - { - "value": "excel", - "description": "Export or Import knowledge base replica including all assets and metadata in Tsv format." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "SourceFilterParameter": { - "name": "source", - "in": "query", - "description": "Source of the QnA.", - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/questionanswering.json b/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/questionanswering.json deleted file mode 100644 index 679abe61f03e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-05-01-preview/questionanswering.json +++ /dev/null @@ -1,533 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Question Answering", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2021-05-01-preview" - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/:query-knowledgebases": { - "post": { - "summary": "Answers the specified question using your knowledge base.", - "operationId": "QuestionAnsweringKnowledgeBase_Query", - "parameters": [ - { - "$ref": "#/parameters/KnowledgeBaseQueryOptions" - }, - { - "$ref": "common.json#/parameters/ProjectNameQueryParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNameQueryParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "A successful response to get answers from knowledge base.", - "schema": { - "$ref": "#/definitions/KnowledgeBaseAnswers" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/SuccessfulQueryKnowledgebases.json" - } - } - } - }, - "/:query-text": { - "post": { - "summary": "Answers the specified question using the provided text in the body.", - "operationId": "QuestionAnsweringText_Query", - "parameters": [ - { - "$ref": "#/parameters/TextQueryOptions" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "A successful response to get answers from input text.", - "schema": { - "$ref": "#/definitions/TextAnswers" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/SuccessfulQueryText.json" - } - } - } - } - }, - "definitions": { - "KnowledgeBaseQueryOptions": { - "type": "object", - "description": "The question parameters to answer using a knowledge base.", - "additionalProperties": false, - "properties": { - "qnaId": { - "type": "integer", - "description": "Exact QnA ID to fetch from the knowledge base, this field takes priority over question.", - "format": "int32" - }, - "question": { - "type": "string", - "description": "User question to query against the knowledge base." - }, - "top": { - "type": "integer", - "description": "Max number of answers to be returned for the question.", - "format": "int32" - }, - "userId": { - "type": "string", - "description": "Unique identifier for the user." - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "description": "Minimum threshold score for answers, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "context": { - "description": "Context object with previous QnA's information.", - "$ref": "#/definitions/KnowledgeBaseAnswerRequestContext" - }, - "rankerType": { - "type": "string", - "description": "(Optional) Set to 'QuestionOnly' for using a question only Ranker.", - "x-ms-enum": { - "name": "RankerType", - "modelAsString": true - }, - "enum": [ - "Default", - "QuestionOnly" - ] - }, - "strictFilters": { - "description": "Filter QnAs based on give metadata list and knowledge base source names.", - "$ref": "#/definitions/StrictFilters" - }, - "answerSpanRequest": { - "description": "To configure Answer span prediction feature.", - "$ref": "#/definitions/AnswerSpanRequest" - }, - "includeUnstructuredSources": { - "type": "boolean", - "description": "(Optional) Flag to enable Query over Unstructured Sources." - } - } - }, - "AnswerSpanRequest": { - "type": "object", - "description": "To configure Answer span prediction feature.", - "additionalProperties": false, - "properties": { - "enable": { - "type": "boolean", - "description": "Enable or disable Answer Span prediction." - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "description": "Minimum threshold score required to include an answer span, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "topAnswersWithSpan": { - "type": "integer", - "description": "Number of Top answers to be considered for span prediction from 1 to 10.", - "format": "int32", - "maximum": 10, - "minimum": 1 - } - } - }, - "KnowledgeBaseAnswerRequestContext": { - "type": "object", - "description": "Context object with previous QnA's information.", - "additionalProperties": false, - "required": [ - "previousQnaId" - ], - "properties": { - "previousQnaId": { - "type": "integer", - "description": "Previous turn top answer result QnA ID.", - "format": "int32" - }, - "previousUserQuery": { - "type": "string", - "description": "Previous user query." - } - } - }, - "KnowledgeBaseAnswers": { - "type": "object", - "description": "Represents List of Question Answers.", - "additionalProperties": false, - "properties": { - "answers": { - "type": "array", - "description": "Represents Answer Result list.", - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswer" - } - } - } - }, - "KnowledgeBaseAnswer": { - "type": "object", - "description": "Represents knowledge base answer.", - "additionalProperties": false, - "properties": { - "questions": { - "type": "array", - "description": "List of questions.", - "items": { - "type": "string" - } - }, - "answer": { - "type": "string", - "description": "The Answer." - }, - "confidenceScore": { - "type": "number", - "description": "Answer confidence score, value ranges from 0 to 1.", - "format": "double", - "maximum": 1, - "minimum": 0 - }, - "id": { - "type": "integer", - "description": "ID of the QnA result.", - "format": "int32" - }, - "source": { - "type": "string", - "description": "Source of QnA result." - }, - "metadata": { - "type": "object", - "description": "Metadata associated with the answer, useful to categorize or filter question answers.", - "additionalProperties": { - "type": "string" - } - }, - "dialog": { - "type": "object", - "$ref": "#/definitions/KnowledgeBaseAnswerDialog" - }, - "answerSpan": { - "type": "object", - "description": "Answer span object of QnA with respect to user's question.", - "$ref": "#/definitions/AnswerSpan" - } - } - }, - "KnowledgeBaseAnswerDialog": { - "type": "object", - "description": "Dialog associated with Answer.", - "properties": { - "isContextOnly": { - "type": "boolean", - "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as search result for queries without context; otherwise, if false, ignores context and includes this QnA in search result." - }, - "prompts": { - "type": "array", - "description": "List of 0 to 20 prompts associated with the answer.", - "maxItems": 20, - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswerPrompt" - } - } - } - }, - "KnowledgeBaseAnswerPrompt": { - "type": "object", - "description": "Prompt for an answer.", - "properties": { - "displayOrder": { - "type": "integer", - "description": "Index of the prompt - used in ordering of the prompts.", - "format": "int32" - }, - "qnaId": { - "type": "integer", - "description": "QnA ID corresponding to the prompt.", - "format": "int32" - }, - "displayText": { - "type": "string", - "description": "Text displayed to represent a follow up question prompt.", - "maxLength": 200 - } - } - }, - "StrictFilters": { - "type": "object", - "description": "filters over knowledge base.", - "additionalProperties": false, - "properties": { - "metadataFilter": { - "type": "object", - "$ref": "#/definitions/MetadataFilter" - }, - "sourceFilter": { - "type": "object", - "$ref": "#/definitions/SourceFilter" - }, - "compoundOperation": { - "type": "string", - "$ref": "#/definitions/CompoundOperationKind", - "default": "AND" - } - } - }, - "MetadataFilter": { - "type": "object", - "description": "Find QnAs that are associated with the given list of metadata.", - "additionalProperties": false, - "properties": { - "metadata": { - "type": "object", - "additionalProperties": { - "type": "string", - "minLength": 0, - "maxLength": 500 - } - }, - "compoundOperation": { - "type": "string", - "$ref": "#/definitions/CompoundOperationKind", - "default": "AND" - } - } - }, - "CompoundOperationKind": { - "type": "string", - "description": "(Optional) Set to 'OR' for joining metadata using 'OR' operation.", - "x-ms-enum": { - "name": "CompoundOperationKind", - "modelAsString": true - }, - "enum": [ - "AND", - "OR" - ] - }, - "SourceFilter": { - "type": "array", - "description": "Find QnAs that are associated with the given list of sources in knowledge base.", - "items": { - "type": "string" - } - }, - "AnswerSpan": { - "type": "object", - "description": "Answer span object of QnA.", - "additionalProperties": false, - "properties": { - "text": { - "type": "string", - "description": "Predicted text of answer span." - }, - "confidenceScore": { - "type": "number", - "description": "Predicted score of answer span, value ranges from 0 to 1.", - "format": "double", - "maximum": 1, - "minimum": 0 - }, - "offset": { - "type": "integer", - "description": "The answer span offset from the start of answer.", - "format": "int32" - }, - "length": { - "type": "integer", - "description": "The length of the answer span.", - "format": "int32" - } - } - }, - "TextQueryOptions": { - "type": "object", - "description": "The question and text record parameters to answer.", - "required": [ - "question", - "records" - ], - "additionalProperties": false, - "properties": { - "question": { - "type": "string", - "description": "User question to query against the given text records." - }, - "records": { - "type": "array", - "description": "Text records to be searched for given question.", - "items": { - "$ref": "#/definitions/TextRecord" - } - }, - "language": { - "$ref": "common.json#/definitions/Language" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - } - }, - "TextAnswers": { - "type": "object", - "description": "Represents the answer results.", - "additionalProperties": false, - "properties": { - "answers": { - "type": "array", - "description": "Represents the answer results.", - "items": { - "$ref": "#/definitions/TextAnswer" - } - } - } - }, - "TextAnswer": { - "type": "object", - "description": "Represents answer result.", - "additionalProperties": false, - "properties": { - "answer": { - "type": "string", - "description": "Answer." - }, - "confidenceScore": { - "type": "number", - "description": "answer confidence score, value ranges from 0 to 1.", - "format": "double", - "maximum": 1, - "minimum": 0 - }, - "id": { - "type": "string", - "description": "record ID." - }, - "answerSpan": { - "type": "object", - "description": "Answer span object with respect to user's question.", - "$ref": "#/definitions/AnswerSpan" - }, - "offset": { - "type": "integer", - "description": "The sentence offset from the start of the document.", - "format": "int32" - }, - "length": { - "type": "integer", - "description": "The length of the sentence.", - "format": "int32" - } - } - }, - "TextRecord": { - "type": "object", - "description": "Represent input text record to be queried.", - "additionalProperties": false, - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the text record." - }, - "text": { - "type": "string", - "description": "Text contents of the record." - } - } - } - }, - "parameters": { - "KnowledgeBaseQueryOptions": { - "name": "knowledgeBaseQueryOptions", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/KnowledgeBaseQueryOptions" - }, - "x-nullable": true, - "description": "Post body of the request.", - "x-ms-parameter-location": "method" - }, - "TextQueryOptions": { - "name": "textQueryOptions", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TextQueryOptions" - }, - "x-nullable": true, - "description": "Post body of the request.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/common.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/common.json deleted file mode 100644 index 6d864b78286b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/common.json +++ /dev/null @@ -1,237 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2021-07-15-preview" - }, - "paths": {}, - "definitions": { - "ErrorResponse": { - "type": "object", - "description": "Error response.", - "additionalProperties": false, - "properties": { - "error": { - "description": "The error object.", - "$ref": "#/definitions/Error" - } - } - }, - "Error": { - "type": "object", - "description": "The error object.", - "additionalProperties": false, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/ErrorCode" - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - }, - "target": { - "type": "string", - "description": "The target of the error." - }, - "details": { - "type": "array", - "description": "An array of details about specific errors that led to this reported error.", - "items": { - "$ref": "#/definitions/Error" - } - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "InnerErrorModel": { - "type": "object", - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", - "additionalProperties": false, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/InnerErrorCode" - }, - "message": { - "type": "string", - "description": "Error message." - }, - "details": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Error details." - }, - "target": { - "type": "string", - "description": "Error target." - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "ErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "ErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidArgument", - "Unauthorized", - "Forbidden", - "NotFound", - "ProjectNotFound", - "OperationNotFound", - "AzureCognitiveSearchNotFound", - "AzureCognitiveSearchIndexNotFound", - "TooManyRequests", - "AzureCognitiveSearchThrottling", - "AzureCognitiveSearchIndexLimitReached", - "InternalServerError", - "ServiceUnavailable" - ] - }, - "InnerErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "InnerErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidParameterValue", - "KnowledgeBaseNotFound", - "AzureCognitiveSearchNotFound", - "AzureCognitiveSearchThrottling", - "ExtractionFailure" - ] - }, - "Language": { - "type": "string", - "description": "Language of the text records. This is BCP-47 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." - }, - "StringIndexType": { - "type": "string", - "description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.", - "default": "TextElements_v8", - "enum": [ - "TextElements_v8", - "UnicodeCodePoint", - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "TextElements_v8", - "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." - }, - { - "value": "UnicodeCodePoint", - "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." - }, - { - "value": "Utf16CodeUnit", - "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - } - } - }, - "parameters": { - "Endpoint": { - "name": "Endpoint", - "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - "ProjectNameQueryParameter": { - "name": "projectName", - "in": "query", - "required": true, - "type": "string", - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "ProjectNamePathParameter": { - "name": "projectName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 100, - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNameQueryParameter": { - "name": "deploymentName", - "in": "query", - "required": true, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNamePathParameter": { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - }, - "TopParameter": { - "name": "top", - "in": "query", - "description": "The maximum number of resources to return from the collection.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "SkipParameter": { - "name": "skip", - "in": "query", - "description": "An offset into the collection of the first resource to be returned.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "MaxPageSizeParameter": { - "name": "maxpagesize", - "in": "query", - "description": "The maximum number of resources to include in a single response.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json deleted file mode 100644 index 2301273ad752..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json +++ /dev/null @@ -1,99 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1", - "deploymentName": "production", - "knowledgeBaseQueryOptions": { - "question": "how long it takes to charge surface?", - "top": 3, - "userId": "sd53lsY=", - "confidenceScoreThreshold": 0.20, - "context": { - "previousQnaId": 9, - "previousUserQuery": "Where are QnA Maker quickstarts?" - }, - "rankerType": "Default", - "filters": { - "metadataFilter": { - "metadata": [ - { - "key": "category", - "value": "api" - }, - { - "key": "editorial", - "value": "chitchat" - } - ], - "logicalOperation": "AND" - }, - "sourceFilter": [ - "filename1.pdf", - "https://www.wikipedia.org/microsoft" - ], - "logicalOperation": "AND" - }, - "answerSpanRequest": { - "enable": true, - "confidenceScoreThreshold": 0.20, - "topAnswersWithSpan": 1 - }, - "includeUnstructuredSources": true - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "answers": [ - { - "questions": [ - "Power and charging" - ], - "answer": "Power and charging**\n\nIt takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.\n\nYou can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface.", - "confidenceScore": 0.65, - "id": 20, - "source": "surface-pro-4-user-guide-EN.pdf", - "metadata": { - "category": "api", - "editorial": "chitchat" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 23, - "displayText": "prompt1" - }, - { - "displayOrder": 2, - "qnaId": 36, - "displayText": "prompt2" - } - ] - }, - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0.30, - "offset": 33, - "length": 50 - } - }, - { - "questions": [ - "Charge your Surface Pro 4" - ], - "answer": "**Charge your Surface Pro 4**\n\n1. Connect the two parts of the power cord.\n\n2. Connect the power cord securely to the charging port.\n\n3. Plug the power supply into an electrical outlet.", - "confidenceScore": 0.32, - "id": 13, - "source": "surface-pro-4-user-guide-EN.pdf" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/SuccessfulQueryText.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/SuccessfulQueryText.json deleted file mode 100644 index 877ca59d290b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/SuccessfulQueryText.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "stringIndexType": "TextElements_v8", - "textQueryOptions": { - "question": "how long it takes to charge surface?", - "records": [ - { - "id": "1", - "text": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it." - }, - { - "id": "2", - "text": "You can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface." - } - ], - "language": "en" - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "answers": [ - { - "answer": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", - "confidenceScore": 0.93, - "id": "1", - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0, - "offset": 28, - "length": 45 - }, - "offset": 0, - "length": 224 - }, - { - "answer": "It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", - "confidenceScore": 0.92, - "id": "1", - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0, - "offset": 8, - "length": 25 - }, - "offset": 20, - "length": 224 - }, - { - "answer": "It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", - "confidenceScore": 0.05, - "id": "1", - "answerSpan": null, - "offset": 110, - "length": 244 - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json deleted file mode 100644 index 53ed64c5949d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1", - "body": { - "description": "proj1 is a test project.", - "language": "en", - "settings": { - "defaultAnswer": "No good match found for your question in the Knowledgebase." - }, - "multilingualResource": true - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "settings": { - "defaultAnswer": "No good match found for your question in the Knowledgebase." - }, - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - }, - "201": { - "headers": {}, - "body": { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "settings": { - "defaultAnswer": "No good match found for your question in the Knowledgebase." - }, - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json deleted file mode 100644 index 8d9aa7385a9d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1" - }, - "responses": { - "202": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulGetProject.json deleted file mode 100644 index 96b235bbd6d3..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulGetProject.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "settings": { - "defaultAnswer": "No good match found for your question in the Knowledgebase." - }, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json deleted file mode 100644 index 783fc8c55498..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": 1, - "answer": "ans1", - "source": "source1", - "questions": [ - "question 1.1", - "question 1.2" - ], - "metadata": { - "k1": "v1", - "k2": "v2" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 11, - "displayText": "prompt 1.1" - }, - { - "displayOrder": 2, - "qnaId": 21, - "displayText": "prompt 1.2" - } - ] - }, - "lastUpdatedDateTime": "2021-05-01T17:21:14Z" - }, - { - "id": 2, - "answer": "ans2", - "source": "source2", - "questions": [ - "question 2.1", - "question 2.2" - ], - "lastUpdatedDateTime": "2021-05-01T17:21:14Z" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulGetSources.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulGetSources.json deleted file mode 100644 index b123db2b8244..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulGetSources.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "displayName": "source1", - "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview", - "sourceKind": "url", - "lastUpdatedDateTime": "2021-05-01T15:13:22Z" - }, - { - "displayName": "source2", - "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf", - "sourceKind": "file", - "contentStructureKind": "unstructured", - "lastUpdatedDateTime": "2021-05-01T15:13:22Z" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json deleted file mode 100644 index ec28c3e629e8..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "alterations": [ - "qnamaker", - "qna maker" - ] - }, - { - "alterations": [ - "botframework", - "bot framework" - ] - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json deleted file mode 100644 index fe20ece4c057..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json deleted file mode 100644 index 252d25ac82c5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1", - "deploymentName": "production", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json deleted file mode 100644 index 11e763559492..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded", - "resultUrl": "https:///language/proj1/export/job1/result" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json deleted file mode 100644 index 58eab6bb09fb..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json deleted file mode 100644 index a0e42df04276..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "deploymentName": "production", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json deleted file mode 100644 index 79268716b472..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1", - "deploymentName": "production" - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "job1" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json deleted file mode 100644 index 722fd74a4dc6..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1", - "body": { - "exportAssetTypes": [ - "qnas", - "synonyms" - ] - } - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "job1" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json deleted file mode 100644 index d1bf6e122055..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json +++ /dev/null @@ -1,78 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1", - "body": { - "assets": { - "synonyms": [ - { - "alterations": [ - "wa", - "washington", - "washington state" - ] - }, - { - "alterations": [ - "U.S", - "usa", - "united states of america" - ] - } - ], - "qnas": [ - { - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "id": 1, - "answer": "ans1", - "source": "source1", - "questions": [ - "question 1.1", - "question 1.2" - ], - "metadata": { - "k1": "v1", - "k2": "v2" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 11, - "displayText": "prompt 1.1" - }, - { - "displayOrder": 2, - "qnaId": 21, - "displayText": "prompt 1.2" - } - ] - } - }, - { - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "id": 2, - "answer": "ans2", - "source": "source2", - "questions": [ - "question 2.1", - "question 2.2" - ] - } - ] - } - } - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "job1" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json deleted file mode 100644 index 79685f619ea1..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - }, - { - "projectName": "proj2", - "description": "proj2 is a test project.", - "language": "fr", - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json deleted file mode 100644 index 5ebce5831232..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1", - "body": { - "records": [ - { - "userId": "user1", - "userQuestion": "hi", - "qnaId": 1 - }, - { - "userId": "user1", - "userQuestion": "hello", - "qnaId": 2 - } - ] - } - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json deleted file mode 100644 index 9cd0ecbe18f2..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1", - "body": [ - { - "op": "add", - "value": { - "id": 3, - "answer": "ans3", - "source": "source1", - "questions": [ - "question 3.1", - "question 3.2" - ], - "metadata": { - "k1": "v1", - "k2": "v2" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 11, - "displayText": "prompt 3.1" - }, - { - "displayOrder": 2, - "qnaId": 21, - "displayText": "prompt 3.2" - } - ] - } - } - }, - { - "op": "replace", - "value": { - "id": 1, - "answer": "ans4", - "source": "source1", - "questions": [ - "question 4.1", - "question 4.2" - ] - } - }, - { - "op": "delete", - "value": { - "id": 2, - "answer": "ans2", - "source": "source1", - "questions": [ - "question 2.1", - "question 2.2" - ] - } - } - ] - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "job1" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json deleted file mode 100644 index 58eab6bb09fb..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json deleted file mode 100644 index 908f6a9aab07..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1", - "body": [ - { - "op": "add", - "value": { - "displayName": "source3", - "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context", - "sourceKind": "url" - } - }, - { - "op": "replace", - "value": { - "displayName": "source1", - "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview", - "sourceKind": "url", - "refresh": true - } - }, - { - "op": "delete", - "value": { - "displayName": "source2", - "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf", - "sourceKind": "file" - } - } - ] - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "job1" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json deleted file mode 100644 index 58eab6bb09fb..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json deleted file mode 100644 index dc08ed4365c7..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-07-15-preview", - "projectName": "proj1", - "body": { - "value": [ - { - "alterations": [ - "qnamaker", - "qna maker" - ] - }, - { - "alterations": [ - "botframework", - "bot framework" - ] - } - ] - } - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/questionanswering-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/questionanswering-authoring.json deleted file mode 100644 index 09350097f8af..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/questionanswering-authoring.json +++ /dev/null @@ -1,1751 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Question Answering - Authoring", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2021-07-15-preview" - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/query-knowledgebases/projects": { - "get": { - "summary": "Gets all projects for a user.", - "operationId": "QuestionAnsweringProjects_ListProjects", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "The metadata of all projects.", - "schema": { - "$ref": "#/definitions/ProjectsMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectsListProjects.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}": { - "get": { - "summary": "Get the requested project metadata.", - "operationId": "QuestionAnsweringProjects_GetProjectDetails", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The metadata for the specified project.", - "schema": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetProject.json" - } - } - }, - "patch": { - "summary": "Create or update a project.", - "operationId": "QuestionAnsweringProjects_CreateProject", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "description": "Parameters needed to create the project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CreateProjectOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The metadata of the updated project, if it already exists.", - "schema": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "201": { - "description": "The metadata of the created project, if it doesn't exist.", - "schema": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulCreateProject.json" - } - } - }, - "delete": { - "summary": "Delete the project.", - "operationId": "QuestionAnsweringProjects_DeleteProject", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulDeleteProject.json" - } - } - } - }, - "/query-knowledgebases/projects/deletion-jobs/{jobId}": { - "get": { - "summary": "Gets the status of a Project delete job.", - "operationId": "QuestionAnsweringProjects_GetDeleteStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Project delete job status.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/:export": { - "post": { - "summary": "Export project metadata and assets.", - "operationId": "QuestionAnsweringProjects_Export", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ImportExportFormatParameter" - }, - { - "$ref": "#/parameters/AssetKindParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/export/jobs/{jobId}": { - "get": { - "summary": "Gets the status of an Export job, once job completes, returns the project metadata, and assets.", - "operationId": "QuestionAnsweringProjects_GetExportStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Export job status, project metadata, and assets.", - "schema": { - "$ref": "#/definitions/ExportJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/:import": { - "post": { - "summary": "Import project assets.", - "operationId": "QuestionAnsweringProjects_Import", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Project assets the needs to be imported.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/ImportJobOptions" - } - }, - { - "$ref": "#/parameters/ImportExportFormatParameter" - }, - { - "$ref": "#/parameters/AssetKindParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/import/jobs/{jobId}": { - "get": { - "summary": "Gets the status of an Import job.", - "operationId": "QuestionAnsweringProjects_GetImportStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Import job status.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}": { - "put": { - "summary": "Deploy project to production.", - "operationId": "QuestionAnsweringProjects_DeployProject", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { - "get": { - "summary": "Gets the status of a Deploy job.", - "operationId": "QuestionAnsweringProjects_GetDeployStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Deploy job state.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/deployments": { - "get": { - "summary": "List all deployments of a project.", - "operationId": "QuestionAnsweringProjects_ListDeployments", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "List of deployments of a project.", - "schema": { - "$ref": "#/definitions/ProjectDeployments" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectListDeployments.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/synonyms": { - "get": { - "summary": "Gets all the synonyms of a project.", - "operationId": "QuestionAnsweringProjects_GetSynonyms", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "All the synonyms of a project.", - "schema": { - "$ref": "#/definitions/SynonymAssets" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetSynonyms.json" - } - } - }, - "put": { - "summary": "Updates all the synonyms of a project.", - "operationId": "QuestionAnsweringProjects_UpdateSynonyms", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "All the synonyms of a project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SynonymAssets" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "204": { - "description": "Synonyms update successfully." - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/sources": { - "get": { - "summary": "Gets all the sources of a project.", - "operationId": "QuestionAnsweringProjects_GetSources", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "All the sources of a project.", - "schema": { - "$ref": "#/definitions/QnaSources" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetSources.json" - } - } - }, - "patch": { - "summary": "Updates the sources of a project.", - "operationId": "QuestionAnsweringProjects_UpdateSources", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Update sources parameters of a project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateSourcesOptions" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSources.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/sources/jobs/{jobId}": { - "get": { - "summary": "Gets the status of update sources job.", - "operationId": "QuestionAnsweringProjects_GetUpdateSourcesStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Update sources job state.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/qnas": { - "get": { - "summary": "Gets all the QnAs of a project.", - "operationId": "QuestionAnsweringProjects_GetQnas", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SourceFilterParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "All the QnAs of a project.", - "schema": { - "$ref": "#/definitions/QnaAssets" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetQnas.json" - } - } - }, - "patch": { - "summary": "Updates the QnAs of a project.", - "operationId": "QuestionAnsweringProjects_UpdateQnas", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Update QnAs parameters of a project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateQnaOptions" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateQnas.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/qnas/jobs/{jobId}": { - "get": { - "summary": "Gets the status of update QnAs job.", - "operationId": "QuestionAnsweringProjects_GetUpdateQnasStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Update QnAs job state.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/feedback": { - "post": { - "summary": "Update Active Learning feedback.", - "operationId": "QuestionAnsweringProjects_AddFeedback", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Feedback for Active Learning.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ActiveLearningFeedback" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "204": { - "description": "Feedback recorded successfully." - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json" - } - } - } - } - }, - "definitions": { - "ActiveLearningFeedback": { - "type": "object", - "description": "Feedback for Active Learning.", - "additionalProperties": false, - "properties": { - "records": { - "$ref": "#/definitions/FeedbackRecords" - } - } - }, - "FeedbackRecords": { - "type": "array", - "description": "A list of Feedback Records for Active Learning.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/FeedbackRecord" - } - }, - "FeedbackRecord": { - "type": "object", - "description": "Feedback Record for Active Learning.", - "additionalProperties": false, - "properties": { - "userId": { - "type": "string", - "description": "Unique identifier of the user." - }, - "userQuestion": { - "type": "string", - "description": "User suggested question for the QnA." - }, - "qnaId": { - "type": "integer", - "description": "Unique ID of the QnA.", - "format": "int32" - } - } - }, - "ProjectsMetadata": { - "type": "object", - "description": "Collection of projects metadata and global settings.", - "additionalProperties": false, - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "nextLink": { - "type": "string" - } - } - }, - "ProjectMetadata": { - "type": "object", - "description": "Represents the project.", - "additionalProperties": false, - "properties": { - "projectName": { - "type": "string", - "description": "Name of the project." - }, - "description": { - "type": "string", - "description": "Description of the project." - }, - "language": { - "$ref": "common.json#/definitions/Language" - }, - "multilingualResource": { - "type": "boolean", - "description": "Resource enabled for multiple languages across projects or not." - }, - "settings": { - "$ref": "#/definitions/ProjectSettings" - }, - "createdDateTime": { - "type": "string", - "description": "Project creation date-time.", - "format": "date-time" - }, - "lastModifiedDateTime": { - "type": "string", - "description": "Represents the project last modified date-time.", - "format": "date-time" - }, - "lastDeployedDateTime": { - "type": "string", - "description": "Represents the project last deployment date-time.", - "format": "date-time" - } - } - }, - "CreateProjectOptions": { - "type": "object", - "description": "Parameters needed to create the project.", - "additionalProperties": false, - "required": [ - "language" - ], - "properties": { - "description": { - "type": "string", - "description": "Description of the project." - }, - "language": { - "$ref": "common.json#/definitions/Language" - }, - "multilingualResource": { - "type": "boolean", - "description": "Set to true to enable creating knowledgebases in different languages for the same resource." - }, - "settings": { - "$ref": "#/definitions/ProjectSettings" - } - } - }, - "ProjectSettings": { - "type": "object", - "description": "Configurable settings of the Project.", - "additionalProperties": false, - "properties": { - "defaultAnswer": { - "type": "string", - "description": "Default Answer response when no good match is found in the knowledge base." - } - } - }, - "ImportJobOptions": { - "type": "object", - "description": "Project assets the needs to be imported.", - "additionalProperties": false, - "properties": { - "metadata": { - "$ref": "#/definitions/CreateProjectOptions" - }, - "assets": { - "$ref": "#/definitions/Assets" - }, - "fileUri": { - "type": "string", - "description": "Import data File URI." - } - } - }, - "JobMetadata": { - "description": "Represents the job metadata.", - "properties": { - "createdDateTime": { - "format": "date-time", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "type": "string" - }, - "jobId": { - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { - "$ref": "#/definitions/JobStatus" - } - }, - "required": [ - "jobId", - "lastUpdatedDateTime", - "createdDateTime", - "status" - ], - "type": "object" - }, - "JobStatus": { - "description": "Job Status.", - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling", - "partiallyCompleted" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "jobStatus" - } - }, - "JobState": { - "description": "Job state represents the job metadata and any errors.", - "allOf": [ - { - "$ref": "#/definitions/JobMetadata" - }, - { - "$ref": "#/definitions/Errors" - } - ] - }, - "Errors": { - "description": "Collection of Error types.", - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - } - } - }, - "ExportJobState": { - "description": "Export job status, project metadata, and assets.", - "allOf": [ - { - "$ref": "#/definitions/JobState" - }, - { - "$ref": "#/definitions/ExportJobResultUrl" - } - ] - }, - "ExportJobResultUrl": { - "type": "object", - "description": "URL to download the result of the Export Job.", - "required": [ - "resultUrl" - ], - "properties": { - "resultUrl": { - "type": "string", - "description": "URL to download the result of the Export Job." - } - } - }, - "Assets": { - "type": "object", - "description": "All assets for this project.", - "additionalProperties": false, - "properties": { - "synonyms": { - "$ref": "#/definitions/SynonymAsset" - }, - "qnas": { - "$ref": "#/definitions/QnaAsset" - } - } - }, - "SynonymAssets": { - "type": "object", - "description": "All synonym assets for this project.", - "additionalProperties": false, - "properties": { - "value": { - "$ref": "#/definitions/SynonymAsset" - }, - "nextLink": { - "type": "string" - } - } - }, - "SynonymAsset": { - "type": "array", - "description": "Collection of synonyms.", - "additionalProperties": false, - "maxLength": 10000, - "items": { - "$ref": "#/definitions/WordAlterations" - } - }, - "WordAlterations": { - "type": "object", - "description": "Collection of word alterations.", - "additionalProperties": false, - "required": [ - "alterations" - ], - "properties": { - "alterations": { - "type": "array", - "description": "Collection of word alterations.", - "maxLength": 20, - "items": { - "type": "string" - } - } - } - }, - "QnaAssets": { - "type": "object", - "description": "All QnA assets for the project.", - "additionalProperties": false, - "properties": { - "value": { - "$ref": "#/definitions/QnaAsset" - }, - "nextLink": { - "type": "string" - } - } - }, - "QnaAsset": { - "type": "array", - "description": "List of QnA records.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/RetrieveQnaRecord" - } - }, - "QnaRecord": { - "type": "object", - "description": "QnA record.", - "additionalProperties": false, - "properties": { - "id": { - "type": "integer", - "description": "Unique ID for the QnA.", - "format": "int32" - }, - "answer": { - "type": "string", - "description": "Answer text.", - "maxLength": 25000, - "minLength": 1 - }, - "source": { - "type": "string", - "description": "Source from which QnA was indexed e.g. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .", - "maxLength": 300 - }, - "questions": { - "type": "array", - "description": "List of questions associated with the answer.", - "maxLength": 100, - "minLength": 1, - "items": { - "type": "string" - } - }, - "metadata": { - "type": "object", - "description": "Metadata associated with the answer, useful to categorize or filter question answers.", - "additionalProperties": { - "type": "string" - } - }, - "dialog": { - "description": "Context of a QnA.", - "$ref": "#/definitions/QnaDialog" - }, - "activeLearningSuggestions": { - "type": "array", - "description": "List of Active Learning suggestions for the QnA.", - "items": { - "$ref": "#/definitions/SuggestedQuestionsCluster" - } - } - } - }, - "SuggestedQuestionsCluster": { - "type": "object", - "description": "Active Learning suggested questions cluster details.", - "additionalProperties": false, - "properties": { - "clusterHead": { - "type": "string", - "description": "Question chosen as the head of suggested questions cluster by Active Learning clustering algorithm." - }, - "suggestedQuestions": { - "type": "array", - "description": "List of all suggested questions for the QnA.", - "items": { - "$ref": "#/definitions/SuggestedQuestion" - } - } - } - }, - "SuggestedQuestion": { - "type": "object", - "description": "Question suggested by the Active Learning feature.", - "additionalProperties": false, - "properties": { - "question": { - "type": "string", - "description": "Question suggested by the Active Learning feature." - }, - "userSuggestedCount": { - "type": "integer", - "description": "The number of times the question was suggested explicitly by the user.", - "format": "int32" - }, - "autoSuggestedCount": { - "type": "integer", - "description": "The number of times the question was suggested automatically by the Active Learning algorithm.", - "format": "int32" - } - } - }, - "RetrieveQnaRecord": { - "description": "QnA Record with last updated date-time.", - "allOf": [ - { - "$ref": "#/definitions/QnaRecord" - }, - { - "$ref": "#/definitions/LastUpdatedDateTimeParameter" - } - ] - }, - "LastUpdatedDateTimeParameter": { - "type": "object", - "description": "Last updated date-time parameter.", - "properties": { - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "Date-time when the QnA was last updated." - } - } - }, - "QnaDialog": { - "type": "object", - "description": "Dialog associated with QnA Record.", - "properties": { - "isContextOnly": { - "type": "boolean", - "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as answer for queries without context; otherwise, ignores context and includes this QnA in answers." - }, - "prompts": { - "type": "array", - "description": "List of prompts associated with the answer.", - "maxItems": 20, - "items": { - "$ref": "#/definitions/QnaPrompt" - } - } - } - }, - "QnaPrompt": { - "type": "object", - "description": "Prompt for an answer.", - "properties": { - "displayOrder": { - "type": "integer", - "description": "Index of the prompt. It is used for ordering of the prompts.", - "format": "int32" - }, - "qnaId": { - "type": "integer", - "description": "ID of the QnA corresponding to the prompt.", - "format": "int32" - }, - "qna": { - "description": "QnA record. Either QnAId or QnA record needs to be present in a Prompt.", - "$ref": "#/definitions/QnaRecord" - }, - "displayText": { - "type": "string", - "description": "Text displayed to represent a follow up question prompt.", - "maxLength": 200 - } - } - }, - "UpdateOperationKind": { - "type": "string", - "description": "Update operation type for assets.", - "enum": [ - "add", - "delete", - "replace" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "updateOperationKind" - } - }, - "UpdateSourcesOptions": { - "type": "array", - "description": "A list of sources to be updated.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/UpdateSourceRecord" - } - }, - "UpdateQnaOptions": { - "type": "array", - "description": "A list of QnAs to be updated.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/UpdateQnaRecord" - } - }, - "UpdateQnaRecord": { - "type": "object", - "description": "QnA record to be updated.", - "additionalProperties": false, - "required": [ - "op", - "value" - ], - "properties": { - "op": { - "type": "string", - "$ref": "#/definitions/UpdateOperationKind" - }, - "value": { - "$ref": "#/definitions/QnaRecord" - } - } - }, - "UpdateSourceRecord": { - "type": "object", - "description": "Source to be updated.", - "additionalProperties": false, - "required": [ - "op", - "value" - ], - "properties": { - "op": { - "type": "string", - "$ref": "#/definitions/UpdateOperationKind" - }, - "value": { - "$ref": "#/definitions/UpdateQnaSourceRecord" - } - } - }, - "QnaSources": { - "type": "object", - "description": "All QnA sources for the project.", - "additionalProperties": false, - "properties": { - "value": { - "$ref": "#/definitions/QnaSourcesMetadata" - }, - "nextLink": { - "type": "string" - } - } - }, - "QnaSourcesMetadata": { - "type": "array", - "description": "Custom sources from which QnAs were extracted or explicitly added to the project.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/QnaSourceRecord" - } - }, - "QnaSourceRecord": { - "description": "Custom source record with last updated date-time.", - "allOf": [ - { - "$ref": "#/definitions/QnaSourceMetadata" - }, - { - "$ref": "#/definitions/LastUpdatedDateTimeParameter" - } - ] - }, - "UpdateQnaSourceRecord": { - "description": "Update source record.", - "allOf": [ - { - "$ref": "#/definitions/QnaSourceMetadata" - }, - { - "$ref": "#/definitions/RefreshSourceOptions" - } - ] - }, - "RefreshSourceOptions": { - "type": "object", - "description": "Boolean flag used to refresh data from the Source.", - "properties": { - "refresh": { - "type": "boolean", - "description": "Boolean flag used to refresh data from the Source." - } - } - }, - "QnaSourceMetadata": { - "type": "object", - "description": "Input source file or url details.", - "additionalProperties": false, - "required": [ - "sourceUri", - "sourceKind" - ], - "properties": { - "displayName": { - "type": "string", - "description": "Friendly name of the Source.", - "maxLength": 200, - "minLength": 1 - }, - "source": { - "type": "string", - "description": "Unique source identifier. Name of the file if it's a 'file' source; otherwise, the complete URL if it's a 'url' source." - }, - "sourceUri": { - "type": "string", - "description": "URI location for the file or url.", - "format": "uri" - }, - "sourceKind": { - "type": "string", - "$ref": "#/definitions/QnaSourceKind", - "default": "url" - }, - "contentStructureKind": { - "type": "string", - "$ref": "#/definitions/SourceContentStructureKind", - "default": "Unstructured" - } - } - }, - "QnaSourceKind": { - "type": "string", - "description": "Supported source types.", - "x-ms-enum": { - "name": "sourceKind", - "modelAsString": true - }, - "enum": [ - "file", - "url" - ] - }, - "SourceContentStructureKind": { - "type": "string", - "description": "Content structure type for sources.", - "enum": [ - "unstructured" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "sourceContentStructureKind" - } - }, - "ProjectDeployments": { - "type": "object", - "description": "All deployments of a project.", - "additionalProperties": false, - "properties": { - "value": { - "$ref": "#/definitions/ProjectDeploymentsList" - }, - "nextLink": { - "type": "string" - } - } - }, - "ProjectDeploymentsList": { - "type": "array", - "description": "List of deployments of a project.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/ProjectDeployment" - } - }, - "ProjectDeployment": { - "type": "object", - "description": "Project deployment details.", - "additionalProperties": false, - "properties": { - "deploymentName": { - "type": "string", - "description": "Name of the deployment." - }, - "lastDeployedDateTime": { - "type": "string", - "description": "Represents the project last deployment date-time.", - "format": "date-time" - } - } - } - }, - "parameters": { - "JobIdParameter": { - "name": "jobId", - "in": "path", - "description": "Job ID.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AssetKindParameter": { - "name": "assetKind", - "type": "string", - "in": "query", - "description": "Kind of the asset of the project.", - "enum": [ - "qnas", - "synonyms" - ], - "x-ms-parameter-location": "method" - }, - "ImportExportFormatParameter": { - "name": "format", - "type": "string", - "in": "query", - "description": "Knowledge base Import or Export format.", - "default": "json", - "enum": [ - "json", - "tsv", - "excel" - ], - "x-ms-enum": { - "name": "format", - "modelAsString": true, - "values": [ - { - "value": "json", - "description": "Export or Import QnA assets in JSON format." - }, - { - "value": "tsv", - "description": "Export or Import knowledge base replica including all assets and metadata in Excel format." - }, - { - "value": "excel", - "description": "Export or Import knowledge base replica including all assets and metadata in Tsv format." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "SourceFilterParameter": { - "name": "source", - "in": "query", - "description": "Source of the QnA.", - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/questionanswering.json b/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/questionanswering.json deleted file mode 100644 index 9a595731e80e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-07-15-preview/questionanswering.json +++ /dev/null @@ -1,562 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Question Answering", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2021-07-15-preview" - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/:query-knowledgebases": { - "post": { - "summary": "Answers the specified question using your knowledge base.", - "operationId": "QuestionAnsweringKnowledgeBase_Query", - "parameters": [ - { - "$ref": "#/parameters/KnowledgeBaseQueryOptions" - }, - { - "$ref": "common.json#/parameters/ProjectNameQueryParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNameQueryParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "A successful response to get answers from knowledge base.", - "schema": { - "$ref": "#/definitions/KnowledgeBaseAnswers" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/SuccessfulQueryKnowledgebases.json" - } - } - } - }, - "/:query-text": { - "post": { - "summary": "Answers the specified question using the provided text in the body.", - "operationId": "QuestionAnsweringText_Query", - "parameters": [ - { - "$ref": "#/parameters/TextQueryOptions" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "A successful response to get answers from input text.", - "schema": { - "$ref": "#/definitions/TextAnswers" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/SuccessfulQueryText.json" - } - } - } - } - }, - "definitions": { - "KnowledgeBaseQueryOptions": { - "type": "object", - "description": "Parameters to query a knowledge base.", - "additionalProperties": false, - "properties": { - "qnaId": { - "type": "integer", - "description": "Exact QnA ID to fetch from the knowledge base, this field takes priority over question.", - "format": "int32" - }, - "question": { - "type": "string", - "description": "User question to query against the knowledge base." - }, - "top": { - "type": "integer", - "description": "Max number of answers to be returned for the question.", - "format": "int32" - }, - "userId": { - "type": "string", - "description": "Unique identifier for the user." - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "description": "Minimum threshold score for answers, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "context": { - "description": "Context object with previous QnA's information.", - "$ref": "#/definitions/KnowledgeBaseAnswerRequestContext" - }, - "rankerType": { - "type": "string", - "description": "Type of ranker to be used.", - "x-ms-enum": { - "name": "RankerType", - "modelAsString": true, - "values": [ - { - "value": "QuestionOnly", - "description": "Question only ranker." - }, - { - "value": "Default", - "description": "Default ranker." - } - ] - }, - "enum": [ - "Default", - "QuestionOnly" - ] - }, - "filters": { - "description": "Filter QnAs based on given metadata list and knowledge base sources.", - "$ref": "#/definitions/QueryFilters" - }, - "answerSpanRequest": { - "description": "To configure Answer span prediction feature.", - "$ref": "#/definitions/AnswerSpanRequest" - }, - "includeUnstructuredSources": { - "type": "boolean", - "description": "(Optional) Flag to enable Query over Unstructured Sources." - } - } - }, - "AnswerSpanRequest": { - "type": "object", - "description": "To configure Answer span prediction feature.", - "additionalProperties": false, - "properties": { - "enable": { - "type": "boolean", - "description": "Enable or disable Answer Span prediction." - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "description": "Minimum threshold score required to include an answer span, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "topAnswersWithSpan": { - "type": "integer", - "description": "Number of Top answers to be considered for span prediction from 1 to 10.", - "format": "int32", - "maximum": 10, - "minimum": 1 - } - } - }, - "KnowledgeBaseAnswerRequestContext": { - "type": "object", - "description": "Context object with previous QnA's information.", - "additionalProperties": false, - "required": [ - "previousQnaId" - ], - "properties": { - "previousQnaId": { - "type": "integer", - "description": "Previous turn top answer result QnA ID.", - "format": "int32" - }, - "previousUserQuery": { - "type": "string", - "description": "Previous user query." - } - } - }, - "KnowledgeBaseAnswers": { - "type": "object", - "description": "Represents List of Question Answers.", - "additionalProperties": false, - "properties": { - "answers": { - "type": "array", - "description": "Represents Answer Result list.", - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswer" - } - } - } - }, - "KnowledgeBaseAnswer": { - "type": "object", - "description": "Represents knowledge base answer.", - "additionalProperties": false, - "properties": { - "questions": { - "type": "array", - "description": "List of questions associated with the answer.", - "items": { - "type": "string" - } - }, - "answer": { - "type": "string", - "description": "Answer text." - }, - "confidenceScore": { - "type": "number", - "description": "Answer confidence score, value ranges from 0 to 1.", - "format": "double", - "maximum": 1, - "minimum": 0 - }, - "id": { - "type": "integer", - "description": "ID of the QnA result.", - "format": "int32" - }, - "source": { - "type": "string", - "description": "Source of QnA result." - }, - "metadata": { - "type": "object", - "description": "Metadata associated with the answer, useful to categorize or filter question answers.", - "additionalProperties": { - "type": "string" - } - }, - "dialog": { - "type": "object", - "$ref": "#/definitions/KnowledgeBaseAnswerDialog" - }, - "answerSpan": { - "type": "object", - "description": "Answer span object of QnA with respect to user's question.", - "$ref": "#/definitions/AnswerSpan" - } - } - }, - "KnowledgeBaseAnswerDialog": { - "type": "object", - "description": "Dialog associated with Answer.", - "properties": { - "isContextOnly": { - "type": "boolean", - "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as search result for queries without context; otherwise, if false, ignores context and includes this QnA in search result." - }, - "prompts": { - "type": "array", - "description": "List of prompts associated with the answer.", - "maxItems": 20, - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswerPrompt" - } - } - } - }, - "KnowledgeBaseAnswerPrompt": { - "type": "object", - "description": "Prompt for an answer.", - "properties": { - "displayOrder": { - "type": "integer", - "description": "Index of the prompt - used in ordering of the prompts.", - "format": "int32" - }, - "qnaId": { - "type": "integer", - "description": "QnA ID corresponding to the prompt.", - "format": "int32" - }, - "displayText": { - "type": "string", - "description": "Text displayed to represent a follow up question prompt.", - "maxLength": 200 - } - } - }, - "QueryFilters": { - "type": "object", - "description": "filters over knowledge base.", - "additionalProperties": false, - "properties": { - "metadataFilter": { - "type": "object", - "$ref": "#/definitions/MetadataFilter" - }, - "sourceFilter": { - "type": "object", - "$ref": "#/definitions/SourceFilter" - }, - "logicalOperation": { - "type": "string", - "description": "Logical operation used to join metadata filter with source filter.", - "$ref": "#/definitions/LogicalOperationKind", - "default": "AND" - } - } - }, - "MetadataFilter": { - "type": "object", - "description": "Find QnAs that are associated with the given list of metadata.", - "additionalProperties": false, - "properties": { - "metadata": { - "type": "array", - "items": { - "$ref": "#/definitions/MetadataRecord" - } - }, - "logicalOperation": { - "type": "string", - "description": "Operation used to join metadata filters.", - "$ref": "#/definitions/LogicalOperationKind", - "default": "AND" - } - } - }, - "MetadataRecord": { - "type": "object", - "description": "Object to provide the key value pair for each metadata.", - "additionalProperties": false, - "required": [ - "key", - "value" - ], - "properties": { - "key": { - "type": "string", - "description": "Metadata Key from Metadata dictionary used in the QnA." - }, - "value": { - "type": "string", - "description": "Metadata Value from Metadata dictionary used in the QnA." - } - } - }, - "LogicalOperationKind": { - "type": "string", - "description": "Set to 'OR' or 'AND' for using corresponding logical operation.", - "x-ms-enum": { - "name": "LogicalOperationKind", - "modelAsString": true - }, - "enum": [ - "AND", - "OR" - ] - }, - "SourceFilter": { - "type": "array", - "description": "Find QnAs that are associated with any of the given list of sources in knowledge base.", - "items": { - "type": "string" - } - }, - "AnswerSpan": { - "type": "object", - "description": "Answer span object of QnA.", - "additionalProperties": false, - "properties": { - "text": { - "type": "string", - "description": "Predicted text of answer span." - }, - "confidenceScore": { - "type": "number", - "description": "Predicted score of answer span, value ranges from 0 to 1.", - "format": "double", - "maximum": 1, - "minimum": 0 - }, - "offset": { - "type": "integer", - "description": "The answer span offset from the start of answer.", - "format": "int32" - }, - "length": { - "type": "integer", - "description": "The length of the answer span.", - "format": "int32" - } - } - }, - "TextQueryOptions": { - "type": "object", - "description": "The question and text record parameters to answer.", - "required": [ - "question", - "records" - ], - "additionalProperties": false, - "properties": { - "question": { - "type": "string", - "description": "User question to query against the given text records." - }, - "records": { - "type": "array", - "description": "Text records to be searched for given question.", - "items": { - "$ref": "#/definitions/TextRecord" - } - }, - "language": { - "$ref": "common.json#/definitions/Language" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - } - }, - "TextAnswers": { - "type": "object", - "description": "Represents the answer results.", - "additionalProperties": false, - "properties": { - "answers": { - "type": "array", - "description": "Represents the answer results.", - "items": { - "$ref": "#/definitions/TextAnswer" - } - } - } - }, - "TextAnswer": { - "type": "object", - "description": "Represents answer result.", - "additionalProperties": false, - "properties": { - "answer": { - "type": "string", - "description": "Answer." - }, - "confidenceScore": { - "type": "number", - "description": "answer confidence score, value ranges from 0 to 1.", - "format": "double", - "maximum": 1, - "minimum": 0 - }, - "id": { - "type": "string", - "description": "record ID." - }, - "answerSpan": { - "type": "object", - "description": "Answer span object with respect to user's question.", - "$ref": "#/definitions/AnswerSpan" - }, - "offset": { - "type": "integer", - "description": "The sentence offset from the start of the document.", - "format": "int32" - }, - "length": { - "type": "integer", - "description": "The length of the sentence.", - "format": "int32" - } - } - }, - "TextRecord": { - "type": "object", - "description": "Represent input text record to be queried.", - "additionalProperties": false, - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the text record." - }, - "text": { - "type": "string", - "description": "Text contents of the record." - } - } - } - }, - "parameters": { - "KnowledgeBaseQueryOptions": { - "name": "knowledgeBaseQueryOptions", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/KnowledgeBaseQueryOptions" - }, - "x-nullable": true, - "description": "Post body of the request.", - "x-ms-parameter-location": "method" - }, - "TextQueryOptions": { - "name": "textQueryOptions", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TextQueryOptions" - }, - "x-nullable": true, - "description": "Post body of the request.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/analyzeconversations.json b/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/analyzeconversations.json deleted file mode 100644 index 7a20d69bad7a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/analyzeconversations.json +++ /dev/null @@ -1,560 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Analyze Conversations", - "description": "This API accepts a request and mediates among multiple language projects, such as LUIS Generally Available, Question Answering, Conversation, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload.\n\n In some cases, this API needs to forward requests and responses between the caller and an upstream service.", - "version": "2021-11-01-preview" - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "description": "An APIM subscription key.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/:analyze-conversations": { - "post": { - "operationId": "ConversationAnalysis_AnalyzeConversation", - "description": "Analyzes the input conversation utterance.", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNameQueryParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNameQueryParameter" - }, - { - "$ref": "#/parameters/ConversationAnalysisOptions" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The conversation analysis response.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationResult" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Arbitration result": { - "$ref": "./examples/conversations/Orchestrator_arbitration.json" - }, - "Conversation project result": { - "$ref": "./examples/conversations/Conversation_project.json" - }, - "Orchestrator direct target result": { - "$ref": "./examples/conversations/Orchestrator_direct_target.json" - } - } - } - } - }, - "definitions": { - "ConversationAnalysisOptions": { - "type": "object", - "description": "The request body.", - "required": [ - "query" - ], - "properties": { - "query": { - "description": "The conversation utterance to be analyzed.", - "type": "string" - }, - "directTarget": { - "type": "string", - "description": "The name of the target project this request is sending to directly." - }, - "language": { - "type": "string", - "description": "The language to use in this request. This will be the language setting when communicating with all other target projects." - }, - "verbose": { - "type": "boolean", - "description": "If true, the service will return more detailed information in the response." - }, - "isLoggingEnabled": { - "description": "If true, the query will be kept by the service for customers to further review, to improve the model quality.", - "type": "boolean" - }, - "parameters": { - "type": "object", - "description": "A dictionary representing the input for each target project.", - "additionalProperties": { - "$ref": "#/definitions/AnalysisParameters" - } - } - } - }, - "AnalysisParameters": { - "type": "object", - "description": "This is the parameter set of either the Orchestration project itself or one of the target services.", - "required": [ - "targetKind" - ], - "discriminator": "targetKind", - "properties": { - "targetKind": { - "type": "string", - "description": "The type of a target service.", - "enum": [ - "luis", - "conversation", - "question_answering", - "non_linked" - ], - "x-ms-enum": { - "name": "targetKind", - "modelAsString": true - } - }, - "apiVersion": { - "type": "string", - "description": "The API version to use when call a specific target service." - } - } - }, - "NoneLinkedTargetIntentResult": { - "type": "object", - "description": "A wrap up of non-linked intent response.", - "x-ms-discriminator-value": "non_linked", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "type": "object", - "$ref": "#/definitions/ConversationResult", - "description": "The actual response from a Conversation project.", - "x-nullable": true - } - } - }, - "LUISParameters": { - "description": "This is a set of request parameters for LUIS Generally Available projects.", - "x-ms-discriminator-value": "luis", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "query": { - "type": "string", - "maxLength": 500, - "description": "The utterance to predict." - }, - "callingOptions": { - "type": "object", - "description": "This customizes how the service calls LUIS Generally Available projects.", - "$ref": "#/definitions/LUISCallingOptions" - } - }, - "additionalProperties": true - }, - "LUISCallingOptions": { - "description": "This customizes how the service calls LUIS Generally Available projects.", - "type": "object", - "properties": { - "verbose": { - "description": "Enable verbose response.", - "type": "boolean" - }, - "log": { - "description": "Save log to add in training utterances later.", - "type": "boolean" - }, - "show-all-intents": { - "description": "Set true to show all intents.", - "type": "boolean" - }, - "timezoneOffset": { - "type": "number", - "description": "The timezone offset for the location of the request." - }, - "spellCheck": { - "type": "boolean", - "description": "Enable spell checking." - }, - "bing-spell-check-subscription-key": { - "description": "The subscription key to use when enabling Bing spell check", - "type": "string" - } - } - }, - "ConversationParameters": { - "type": "object", - "description": "This is a set of request parameters for Customized Conversation projects.", - "x-ms-discriminator-value": "conversation", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "callingOptions": { - "type": "object", - "$ref": "#/definitions/ConversationCallingOptions" - } - } - }, - "ConversationCallingOptions": { - "type": "object", - "description": "The option to set to call a Conversation project.", - "properties": { - "language": { - "description": "The language of the query.", - "type": "string" - }, - "verbose": { - "description": "If true, the service will return more detailed information.", - "type": "boolean" - }, - "isLoggingEnabled": { - "description": "If true, the query will be saved for customers to further review in authoring, to improve the model quality.", - "type": "boolean" - } - } - }, - "QuestionAnsweringParameters": { - "type": "object", - "description": "This is a set of request parameters for Question Answering knowledge bases.", - "x-ms-discriminator-value": "question_answering", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "callingOptions": { - "type": "object", - "description": "The options sent to a Question Answering KB." - } - } - }, - "AnalyzeConversationResult": { - "type": "object", - "description": "Represents a conversation analysis response.", - "required": [ - "query", - "prediction" - ], - "properties": { - "query": { - "type": "string", - "description": "The conversation utterance given by the caller." - }, - "detectedLanguage": { - "type": "string", - "description": "The system detected language for the query." - }, - "prediction": { - "description": "The prediction result of a conversation project.", - "$ref": "#/definitions/BasePrediction" - } - } - }, - "BasePrediction": { - "type": "object", - "description": "This is the base class of prediction", - "required": [ - "projectKind" - ], - "discriminator": "projectKind", - "properties": { - "projectKind": { - "type": "string", - "description": "The type of the project.", - "enum": [ - "conversation", - "workflow" - ], - "x-ms-enum": { - "name": "projectKind", - "modelAsString": true - } - }, - "topIntent": { - "type": "string", - "description": "The intent with the highest score." - } - } - }, - "OrchestratorPrediction": { - "type": "object", - "description": "This represents the prediction result of an Orchestrator project.", - "x-ms-discriminator-value": "workflow", - "required": [ - "intents" - ], - "allOf": [ - { - "$ref": "#/definitions/BasePrediction" - } - ], - "properties": { - "intents": { - "description": "A dictionary that contains all intents. A key is an intent name and a value is its confidence score and target type. The top intent's value also contains the actual response from the target project.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TargetIntentResult" - } - } - } - }, - "TargetIntentResult": { - "type": "object", - "description": "This is the base class of an intent prediction", - "discriminator": "targetKind", - "required": [ - "confidenceScore", - "targetKind" - ], - "properties": { - "targetKind": { - "type": "string", - "description": "This discriminator property specifies the type of the target project that returns the response.", - "enum": [ - "luis", - "conversation", - "question_answering", - "non_linked" - ], - "x-ms-enum": { - "name": "targetKind", - "modelAsString": true - } - }, - "apiVersion": { - "type": "string", - "description": "The API version used to call a target service." - }, - "confidenceScore": { - "type": "number", - "format": "float", - "x-ms-client-name": "confidence", - "description": "The prediction score and it ranges from 0.0 to 1.0.", - "minimum": 0, - "maximum": 1 - } - } - }, - "ConversationTargetIntentResult": { - "type": "object", - "description": "A wrap up of Conversation project response.", - "x-ms-discriminator-value": "conversation", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "type": "object", - "$ref": "#/definitions/ConversationResult", - "description": "The actual response from a Conversation project.", - "x-nullable": true - } - } - }, - "ConversationResult": { - "type": "object", - "description": "The response returned by a Conversation project.", - "required": [ - "query", - "prediction" - ], - "properties": { - "query": { - "description": "The same query given in request.", - "type": "string" - }, - "detectedLanguage": { - "description": "The detected language from the query.", - "type": "string" - }, - "prediction": { - "description": "The predicted result for the query.", - "$ref": "#/definitions/ConversationPrediction" - } - } - }, - "ConversationPrediction": { - "type": "object", - "description": "Represents the prediction section of a Conversation project.", - "x-ms-discriminator-value": "conversation", - "required": [ - "intents", - "entities" - ], - "allOf": [ - { - "$ref": "#/definitions/BasePrediction" - } - ], - "properties": { - "intents": { - "description": "The intent classification results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationIntent" - } - }, - "entities": { - "description": "The entity extraction results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationEntity" - } - } - } - }, - "ConversationIntent": { - "type": "object", - "description": "The intent classification result of a Conversation project.", - "required": [ - "category", - "confidenceScore" - ], - "properties": { - "category": { - "description": "A predicted class.", - "type": "string" - }, - "confidenceScore": { - "format": "float", - "x-ms-client-name": "confidence", - "description": "The confidence score of the class from 0.0 to 1.0.", - "type": "number", - "minimum": 0, - "maximum": 1 - } - } - }, - "ConversationEntity": { - "type": "object", - "description": "The entity extraction result of a Conversation project.", - "required": [ - "category", - "text", - "offset", - "length", - "confidenceScore" - ], - "properties": { - "category": { - "description": "The entity category.", - "type": "string" - }, - "text": { - "description": "The predicted entity text.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "The starting index of this entity in the query.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "The length of the text.", - "type": "integer" - }, - "confidenceScore": { - "format": "float", - "x-ms-client-name": "confidence", - "description": "The entity confidence score.", - "type": "number" - }, - "listKeys": { - "type": "array", - "description": "List of keys.", - "items": { - "type": "string" - } - } - } - }, - "LUISTargetIntentResult": { - "type": "object", - "description": "It is a wrap up of LUIS Generally Available response.", - "x-ms-discriminator-value": "luis", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "type": "object", - "description": "The actual response from a LUIS Generally Available application.", - "x-nullable": true - } - } - }, - "QuestionAnsweringTargetIntentResult": { - "type": "object", - "description": "It is a wrap up a Question Answering KB response.", - "x-ms-discriminator-value": "question_answering", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "type": "object", - "$ref": "../2021-07-15-preview/questionanswering.json#/definitions/KnowledgeBaseAnswers", - "description": "The generated answer by a Question Answering KB.", - "x-nullable": true - } - } - } - }, - "parameters": { - "ConversationAnalysisOptions": { - "name": "ConversationAnalysisOptions", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationAnalysisOptions" - }, - "description": "Post body of the request.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/analyzetext.json b/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/analyzetext.json deleted file mode 100644 index 1f67edb9b527..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/analyzetext.json +++ /dev/null @@ -1,2205 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Text Analysis", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.0", - "version": "2021-11-01-preview" - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "#/parameters/Endpoint" - } - ] - }, - "paths": { - "/analyze-text/jobs": { - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "description": "Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed.", - "operationId": "AnalyzeText_SubmitJob", - "summary": "Submit text analysis job", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "description": "Collection of documents to analyze and tasks to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeTextJobsInput" - } - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Submit Analysis Job Request": { - "$ref": "./examples/SuccessfulAnalyzeTextJobSubmitRequest.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/analyze-text/jobs/{jobId}": { - "get": { - "produces": [ - "application/json" - ], - "description": "Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are completed, the job will transition to the completed state and results will be available for each task.", - "operationId": "AnalyzeText_JobStatus", - "summary": "Get analysis status and results", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobId" - }, - { - "$ref": "#/parameters/ShowStats" - }, - { - "default": 20, - "description": "(Optional) Set the maximum number of results per task. When both top and skip are specified, skip is applied first.", - "in": "query", - "maximum": 50, - "minimum": 1, - "name": "top", - "type": "integer" - }, - { - "default": 0, - "description": "(Optional) Set the number of elements to offset in the response. When both top and skip are specified, skip is applied first.", - "in": "query", - "minimum": 0, - "name": "skip", - "type": "integer" - } - ], - "responses": { - "200": { - "description": "Analysis job status and metadata.", - "schema": { - "$ref": "#/definitions/AnalyzeTextJobState" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Text Analysis Job Status Request": { - "$ref": "./examples/SuccessfulAnalyzeTextJobStatusRequest.json" - } - } - } - } - }, - "definitions": { - "AnalyzeTextJobsInput": { - "properties": { - "displayName": { - "description": "Optional display name for the analysis job.", - "type": "string" - }, - "analysisInput": { - "description": "Input for the analysis job.", - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/definitions/MultiLanguageInput" - } - } - } - }, - "tasks": { - "description": "The set of tasks to execute on the input documents.", - "properties": { - "entityRecognitionTasks": { - "type": "array", - "items": { - "$ref": "#/definitions/EntitiesTask" - } - }, - "entityRecognitionPiiTasks": { - "type": "array", - "items": { - "$ref": "#/definitions/PiiTask" - } - }, - "keyPhraseExtractionTasks": { - "type": "array", - "items": { - "$ref": "#/definitions/KeyPhraseTask" - } - }, - "entityLinkingTasks": { - "type": "array", - "items": { - "$ref": "#/definitions/EntityLinkingTask" - } - }, - "sentimentAnalysisTasks": { - "type": "array", - "items": { - "$ref": "#/definitions/SentimentAnalysisTask" - } - }, - "extractiveSummarizationTasks": { - "type": "array", - "items": { - "$ref": "#/definitions/ExtractiveSummarizationTask" - } - }, - "customEntityRecognitionTasks": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomEntitiesTask" - } - }, - "customSingleClassificationTasks": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomSingleClassificationTask" - } - }, - "customMultiClassificationTasks": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomMultiClassificationTask" - } - } - }, - "type": "object" - } - }, - "required": [ - "analysisInput", - "tasks" - ] - }, - "TaskParameters": { - "type": "object", - "description": "Base parameters object for a text analysis task.", - "properties": { - "loggingOptOut": { - "type": "boolean", - "default": false - } - } - }, - "PreBuiltTaskParameters": { - "type": "object", - "description": "Parameters object for a text analysis task using pre-built models.", - "properties": { - "modelVersion": { - "type": "string", - "default": "latest" - } - } - }, - "PreBuiltResult": { - "properties": { - "errors": { - "type": "array", - "description": "Errors by record id.", - "items": { - "$ref": "#/definitions/DocumentError" - } - }, - "statistics": { - "$ref": "#/definitions/RequestStatistics" - }, - "modelVersion": { - "type": "string", - "description": "This field indicates which model is used for scoring." - } - }, - "required": [ - "errors", - "modelVersion" - ] - }, - "CustomTaskParameters": { - "type": "object", - "description": "Parameters object for a text analysis task using custom models.", - "properties": { - "projectName": { - "type": "string" - }, - "deploymentName": { - "type": "string" - } - }, - "required": [ - "projectName", - "deploymentName" - ] - }, - "CustomResult": { - "properties": { - "errors": { - "type": "array", - "description": "Errors by record id.", - "items": { - "$ref": "#/definitions/DocumentError" - } - }, - "statistics": { - "$ref": "#/definitions/RequestStatistics" - }, - "projectName": { - "type": "string", - "description": "This field indicates the project name for the model." - }, - "deploymentName": { - "type": "string", - "description": "This field indicates the deployment name for the model." - } - }, - "required": [ - "errors", - "projectName", - "deploymentName" - ] - }, - "CustomEntitiesTask": { - "type": "object", - "description": "Use custom models to ease the process of information extraction from unstructured documents like contracts or financial documents", - "properties": { - "taskName": { - "type": "string" - }, - "parameters": { - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - }, - { - "$ref": "#/definitions/CustomTaskParameters" - }, - { - "$ref": "#/definitions/EntitiesTaskParameters" - } - ] - } - } - }, - "CustomEntitiesTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomEntitiesResult" - } - } - }, - "CustomEntitiesResult": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CustomResult" - }, - { - "$ref": "#/definitions/EntitiesDocuments" - } - ] - }, - "CustomSingleClassificationTask": { - "type": "object", - "description": "Use custom models to classify text into single label taxonomy", - "properties": { - "taskName": { - "type": "string" - }, - "parameters": { - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - }, - { - "$ref": "#/definitions/CustomTaskParameters" - } - ] - } - } - }, - "CustomSingleClassificationTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomSingleClassificationResult" - } - } - }, - "CustomSingleClassificationResult": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CustomResult" - }, - { - "$ref": "#/definitions/SingleClassificationDocuments" - } - ] - }, - "SingleClassificationDocuments": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by record", - "items": { - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - }, - { - "$ref": "#/definitions/SingleClassificationDocumentResult" - } - ] - } - } - }, - "required": [ - "documents" - ] - }, - "SingleClassificationDocumentResult": { - "type": "object", - "required": [ - "classification" - ], - "properties": { - "classification": { - "$ref": "#/definitions/ClassificationResult" - } - } - }, - "ClassificationResult": { - "type": "object", - "required": [ - "category", - "confidenceScore" - ], - "properties": { - "category": { - "type": "string", - "description": "Classification type." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the recognized classification." - } - } - }, - "CustomMultiClassificationTask": { - "type": "object", - "description": "Use custom models to classify text into multi label taxonomy", - "properties": { - "taskName": { - "type": "string" - }, - "parameters": { - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - }, - { - "$ref": "#/definitions/CustomTaskParameters" - } - ] - } - } - }, - "CustomMultiClassificationTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomMultiClassificationResult" - } - } - }, - "CustomMultiClassificationResult": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CustomResult" - }, - { - "$ref": "#/definitions/MultiClassificationDocuments" - } - ] - }, - "MultiClassificationDocuments": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by record", - "items": { - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - }, - { - "$ref": "#/definitions/MultiClassificationDocumentResult" - } - ] - } - } - } - }, - "MultiClassificationDocumentResult": { - "type": "object", - "required": [ - "classifications" - ], - "properties": { - "classifications": { - "type": "array", - "items": { - "$ref": "#/definitions/ClassificationResult" - } - } - } - }, - "SentimentAnalysisTaskParameters": { - "type": "object", - "description": "Parameters object for a Sentiment Analysis task.", - "properties": { - "opinionMining": { - "type": "boolean", - "default": false - }, - "stringIndexType": { - "$ref": "#/definitions/StringIndexType" - } - } - }, - "SentimentAnalysisTask": { - "type": "object", - "description": "An object representing the task definition for a Sentiment Analysis task.", - "properties": { - "taskName": { - "type": "string" - }, - "parameters": { - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - }, - { - "$ref": "#/definitions/PreBuiltTaskParameters" - }, - { - "$ref": "#/definitions/SentimentAnalysisTaskParameters" - } - ] - } - } - }, - "SentimentTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/SentimentResult" - } - } - }, - "SentimentResult": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - }, - { - "$ref": "#/definitions/SentimentDocuments" - } - ] - }, - "SentimentDocuments": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Sentiment analysis per record.", - "items": { - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - }, - { - "$ref": "#/definitions/SentimentDocumentResult" - } - ] - } - } - }, - "required": [ - "documents" - ] - }, - "SentimentDocumentResult": { - "type": "object", - "properties": { - "sentiment": { - "type": "string", - "description": "Predicted sentiment for record (Negative, Neutral, Positive, or Mixed).", - "enum": [ - "positive", - "neutral", - "negative", - "mixed" - ], - "x-ms-enum": { - "name": "DocumentSentimentValue", - "modelAsString": false - } - }, - "confidenceScores": { - "description": "Document level sentiment confidence scores between 0 and 1 for each sentiment class.", - "$ref": "#/definitions/SentimentConfidenceScorePerLabel" - }, - "sentences": { - "type": "array", - "description": "Sentence level sentiment analysis.", - "items": { - "$ref": "#/definitions/SentenceSentiment" - } - } - }, - "required": [ - "sentiment", - "confidenceScores", - "sentences" - ] - }, - "SentimentConfidenceScorePerLabel": { - "type": "object", - "required": [ - "positive", - "neutral", - "negative" - ], - "properties": { - "positive": { - "type": "number", - "format": "double" - }, - "neutral": { - "type": "number", - "format": "double" - }, - "negative": { - "type": "number", - "format": "double" - } - }, - "description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative." - }, - "SentenceSentiment": { - "type": "object", - "required": [ - "text", - "sentiment", - "confidenceScores", - "offset", - "length" - ], - "properties": { - "text": { - "type": "string", - "description": "The sentence text." - }, - "sentiment": { - "type": "string", - "description": "The predicted Sentiment for the sentence.", - "enum": [ - "positive", - "neutral", - "negative" - ], - "x-ms-enum": { - "name": "SentenceSentimentValue", - "modelAsString": false - } - }, - "confidenceScores": { - "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes.", - "$ref": "#/definitions/SentimentConfidenceScorePerLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The sentence offset from the start of the record." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the sentence." - }, - "targets": { - "type": "array", - "description": "The array of sentence targets for the sentence.", - "items": { - "$ref": "#/definitions/SentenceTarget" - } - }, - "assessments": { - "type": "array", - "description": "The array of assessments for the sentence.", - "items": { - "$ref": "#/definitions/SentenceAssessment" - } - } - } - }, - "SentenceTarget": { - "type": "object", - "required": [ - "confidenceScores", - "length", - "offset", - "relations", - "sentiment", - "text" - ], - "properties": { - "sentiment": { - "type": "string", - "enum": [ - "positive", - "mixed", - "negative" - ], - "x-ms-enum": { - "name": "TokenSentimentValue", - "modelAsString": false - }, - "description": "Targeted sentiment in the sentence." - }, - "confidenceScores": { - "description": "Target sentiment confidence scores for the target in the sentence.", - "$ref": "#/definitions/TargetConfidenceScoreLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The target offset from the start of the sentence." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the target." - }, - "text": { - "type": "string", - "description": "The target text detected." - }, - "relations": { - "type": "array", - "description": "The array of either assessment or target objects which is related to the target.", - "items": { - "$ref": "#/definitions/TargetRelation" - } - } - } - }, - "SentenceAssessment": { - "type": "object", - "required": [ - "confidenceScores", - "isNegated", - "length", - "offset", - "sentiment", - "text" - ], - "properties": { - "sentiment": { - "type": "string", - "enum": [ - "positive", - "mixed", - "negative" - ], - "x-ms-enum": { - "name": "TokenSentimentValue", - "modelAsString": false - }, - "description": "Assessment sentiment in the sentence." - }, - "confidenceScores": { - "description": "Assessment sentiment confidence scores in the sentence.", - "$ref": "#/definitions/TargetConfidenceScoreLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The assessment offset from the start of the sentence." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the assessment." - }, - "text": { - "type": "string", - "description": "The assessment text detected." - }, - "isNegated": { - "type": "boolean", - "description": "The indicator representing if the assessment is negated." - } - } - }, - "TargetRelation": { - "type": "object", - "required": [ - "ref", - "relationType" - ], - "properties": { - "relationType": { - "type": "string", - "enum": [ - "assessment", - "target" - ], - "x-ms-enum": { - "name": "TargetRelationType", - "modelAsString": false - }, - "description": "The type related to the target." - }, - "ref": { - "type": "string", - "description": "The JSON pointer indicating the linked object." - } - } - }, - "TargetConfidenceScoreLabel": { - "type": "object", - "required": [ - "negative", - "positive" - ], - "properties": { - "positive": { - "type": "number", - "format": "double" - }, - "negative": { - "type": "number", - "format": "double" - } - }, - "description": "Represents the confidence scores across all sentiment classes: positive, neutral, negative." - }, - "EntitiesTaskParameters": { - "type": "object", - "description": "Parameters object for a Sentiment Analysis task.", - "properties": { - "stringIndexType": { - "$ref": "#/definitions/StringIndexType" - } - } - }, - "EntitiesTask": { - "type": "object", - "description": "An object representing the task definition for an Entities Recognition task.", - "properties": { - "taskName": { - "type": "string" - }, - "parameters": { - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - }, - { - "$ref": "#/definitions/PreBuiltTaskParameters" - }, - { - "$ref": "#/definitions/EntitiesTaskParameters" - } - ] - } - } - }, - "EntitiesTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntitiesResult" - } - } - }, - "EntitiesResult": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - }, - { - "$ref": "#/definitions/EntitiesDocuments" - } - ] - }, - "EntitiesDocuments": { - "type": "object", - "required": [ - "documents" - ], - "properties": { - "documents": { - "type": "array", - "items": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - }, - { - "$ref": "#/definitions/EntitiesDocumentResult" - } - ] - } - } - } - }, - "EntitiesDocumentResult": { - "type": "object", - "required": [ - "entities" - ], - "properties": { - "entities": { - "type": "array", - "items": { - "$ref": "#/definitions/Entity" - } - } - } - }, - "Entity": { - "type": "object", - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ], - "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "type": "string", - "description": "Entity type." - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub type." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted entity." - } - } - }, - "EntityLinkingTaskParameters": { - "type": "object", - "description": "Parameters object for a Sentiment Analysis task.", - "properties": { - "stringIndexType": { - "$ref": "#/definitions/StringIndexType" - } - } - }, - "EntityLinkingTask": { - "type": "object", - "description": "An object representing the task definition for an Entity Linking task.", - "properties": { - "taskName": { - "type": "string" - }, - "parameters": { - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - }, - { - "$ref": "#/definitions/PreBuiltTaskParameters" - }, - { - "$ref": "#/definitions/EntityLinkingTaskParameters" - } - ] - } - } - }, - "EntityLinkingTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntityLinkingResult" - } - } - }, - "EntityLinkingResult": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - }, - { - "$ref": "#/definitions/LinkedEntitiesDocuments" - } - ] - }, - "LinkedEntitiesDocuments": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by record", - "items": { - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - }, - { - "$ref": "#/definitions/LinkedEntitiesDocumentResult" - } - ] - } - } - }, - "required": [ - "documents" - ] - }, - "LinkedEntitiesDocumentResult": { - "type": "object", - "required": [ - "entities" - ], - "properties": { - "entities": { - "type": "array", - "description": "Recognized well known entities in the record.", - "items": { - "$ref": "#/definitions/LinkedEntity" - } - } - } - }, - "LinkedEntity": { - "type": "object", - "required": [ - "name", - "matches", - "language", - "url", - "dataSource" - ], - "properties": { - "name": { - "type": "string", - "description": "Entity Linking formal name." - }, - "matches": { - "type": "array", - "description": "List of instances this entity appears in the text.", - "items": { - "$ref": "#/definitions/Match" - } - }, - "language": { - "type": "string", - "description": "Language used in the data source." - }, - "id": { - "type": "string", - "description": "Unique identifier of the recognized entity from the data source." - }, - "url": { - "type": "string", - "description": "URL for the entity's page from the data source." - }, - "dataSource": { - "type": "string", - "description": "Data source used to extract entity linking, such as Wiki/Bing etc." - }, - "bingId": { - "type": "string", - "description": "Bing Entity Search API unique identifier of the recognized entity." - } - } - }, - "Match": { - "type": "object", - "required": [ - "confidenceScore", - "text", - "offset", - "length" - ], - "properties": { - "confidenceScore": { - "type": "number", - "format": "double", - "description": "If a well known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned." - }, - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity match text." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity match text." - } - } - }, - "PiiTaskParameters": { - "type": "object", - "description": "Parameters object for a PII Entities Recognition task.", - "properties": { - "domain": { - "type": "string", - "default": "none", - "enum": [ - "phi", - "none" - ] - }, - "piiCategories": { - "$ref": "#/definitions/PiiCategories" - }, - "stringIndexType": { - "$ref": "#/definitions/StringIndexType" - } - } - }, - "PiiTask": { - "type": "object", - "description": "An object representing the task definition for a PII Entities Recognition task.", - "properties": { - "taskName": { - "type": "string" - }, - "parameters": { - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - }, - { - "$ref": "#/definitions/PreBuiltTaskParameters" - }, - { - "$ref": "#/definitions/PiiTaskParameters" - } - ] - } - } - }, - "PiiTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/PiiResult" - } - } - }, - "PiiResult": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - }, - { - "$ref": "#/definitions/PiiEntitiesDocuments" - } - ] - }, - "PiiEntitiesDocuments": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - }, - { - "$ref": "#/definitions/PiiEntitiesDocumentResult" - } - ] - } - } - }, - "required": [ - "documents" - ] - }, - "PiiEntitiesDocumentResult": { - "type": "object", - "required": [ - "redactedText", - "entities" - ], - "properties": { - "redactedText": { - "type": "string", - "description": "Returns redacted text." - }, - "entities": { - "type": "array", - "description": "Recognized entities in the record.", - "items": { - "$ref": "#/definitions/Entity" - } - } - } - }, - "PiiCategories": { - "description": "(Optional) describes the PII categories to return", - "items": { - "type": "string", - "x-ms-enum": { - "name": "PiiCategory", - "modelAsString": true - }, - "enum": [ - "ABARoutingNumber", - "ARNationalIdentityNumber", - "AUBankAccountNumber", - "AUDriversLicenseNumber", - "AUMedicalAccountNumber", - "AUPassportNumber", - "AUTaxFileNumber", - "AUBusinessNumber", - "AUCompanyNumber", - "ATIdentityCard", - "ATTaxIdentificationNumber", - "ATValueAddedTaxNumber", - "AzureDocumentDBAuthKey", - "AzureIAASDatabaseConnectionAndSQLString", - "AzureIoTConnectionString", - "AzurePublishSettingPassword", - "AzureRedisCacheString", - "AzureSAS", - "AzureServiceBusString", - "AzureStorageAccountKey", - "AzureStorageAccountGeneric", - "BENationalNumber", - "BENationalNumberV2", - "BEValueAddedTaxNumber", - "BRCPFNumber", - "BRLegalEntityNumber", - "BRNationalIDRG", - "BGUniformCivilNumber", - "CABankAccountNumber", - "CADriversLicenseNumber", - "CAHealthServiceNumber", - "CAPassportNumber", - "CAPersonalHealthIdentification", - "CASocialInsuranceNumber", - "CLIdentityCardNumber", - "CNResidentIdentityCardNumber", - "CreditCardNumber", - "HRIdentityCardNumber", - "HRNationalIDNumber", - "HRPersonalIdentificationNumber", - "HRPersonalIdentificationOIBNumberV2", - "CYIdentityCard", - "CYTaxIdentificationNumber", - "CZPersonalIdentityNumber", - "CZPersonalIdentityV2", - "DKPersonalIdentificationNumber", - "DKPersonalIdentificationV2", - "DrugEnforcementAgencyNumber", - "EEPersonalIdentificationCode", - "EUDebitCardNumber", - "EUDriversLicenseNumber", - "EUGPSCoordinates", - "EUNationalIdentificationNumber", - "EUPassportNumber", - "EUSocialSecurityNumber", - "EUTaxIdentificationNumber", - "FIEuropeanHealthNumber", - "FINationalID", - "FINationalIDV2", - "FIPassportNumber", - "FRDriversLicenseNumber", - "FRHealthInsuranceNumber", - "FRNationalID", - "FRPassportNumber", - "FRSocialSecurityNumber", - "FRTaxIdentificationNumber", - "FRValueAddedTaxNumber", - "DEDriversLicenseNumber", - "DEPassportNumber", - "DEIdentityCardNumber", - "DETaxIdentificationNumber", - "DEValueAddedNumber", - "GRNationalIDCard", - "GRNationalIDV2", - "GRTaxIdentificationNumber", - "HKIdentityCardNumber", - "HUValueAddedNumber", - "HUPersonalIdentificationNumber", - "HUTaxIdentificationNumber", - "INPermanentAccount", - "INUniqueIdentificationNumber", - "IDIdentityCardNumber", - "InternationalBankingAccountNumber", - "IEPersonalPublicServiceNumber", - "IEPersonalPublicServiceNumberV2", - "ILBankAccountNumber", - "ILNationalID", - "ITDriversLicenseNumber", - "ITFiscalCode", - "ITValueAddedTaxNumber", - "JPBankAccountNumber", - "JPDriversLicenseNumber", - "JPPassportNumber", - "JPResidentRegistrationNumber", - "JPSocialInsuranceNumber", - "JPMyNumberCorporate", - "JPMyNumberPersonal", - "JPResidenceCardNumber", - "LVPersonalCode", - "LTPersonalCode", - "LUNationalIdentificationNumberNatural", - "LUNationalIdentificationNumberNonNatural", - "MYIdentityCardNumber", - "MTIdentityCardNumber", - "MTTaxIDNumber", - "NLCitizensServiceNumber", - "NLCitizensServiceNumberV2", - "NLTaxIdentificationNumber", - "NLValueAddedTaxNumber", - "NZBankAccountNumber", - "NZDriversLicenseNumber", - "NZInlandRevenueNumber", - "NZMinistryOfHealthNumber", - "NZSocialWelfareNumber", - "NOIdentityNumber", - "PHUnifiedMultiPurposeIDNumber", - "PLIdentityCard", - "PLNationalID", - "PLNationalIDV2", - "PLPassportNumber", - "PLTaxIdentificationNumber", - "PLREGONNumber", - "PTCitizenCardNumber", - "PTCitizenCardNumberV2", - "PTTaxIdentificationNumber", - "ROPersonalNumericalCode", - "RUPassportNumberDomestic", - "RUPassportNumberInternational", - "SANationalID", - "SGNationalRegistrationIdentityCardNumber", - "SKPersonalNumber", - "SITaxIdentificationNumber", - "SIUniqueMasterCitizenNumber", - "ZAIdentificationNumber", - "KRResidentRegistrationNumber", - "ESDNI", - "ESSocialSecurityNumber", - "ESTaxIdentificationNumber", - "SQLServerConnectionString", - "SENationalID", - "SENationalIDV2", - "SEPassportNumber", - "SETaxIdentificationNumber", - "SWIFTCode", - "CHSocialSecurityNumber", - "TWNationalID", - "TWPassportNumber", - "TWResidentCertificate", - "THPopulationIdentificationCode", - "TRNationalIdentificationNumber", - "UKDriversLicenseNumber", - "UKElectoralRollNumber", - "UKNationalHealthNumber", - "UKNationalInsuranceNumber", - "UKUniqueTaxpayerNumber", - "USUKPassportNumber", - "USBankAccountNumber", - "USDriversLicenseNumber", - "USIndividualTaxpayerIdentification", - "USSocialSecurityNumber", - "UAPassportNumberDomestic", - "UAPassportNumberInternational", - "Organization", - "Email", - "URL", - "Age", - "PhoneNumber", - "IPAddress", - "Date", - "Person", - "Address", - "All", - "Default" - ] - }, - "type": "array", - "uniqueItems": true - }, - "ExtractiveSummarizationTaskParameters": { - "type": "object", - "description": "Parameters object for an Extractive Summarization task.", - "properties": { - "sentenceCount": { - "type": "integer", - "default": 3 - }, - "sortBy": { - "type": "string", - "default": "Offset", - "enum": [ - "Offset", - "Rank" - ] - }, - "stringIndexType": { - "$ref": "#/definitions/StringIndexType" - } - } - }, - "ExtractiveSummarizationTask": { - "type": "object", - "description": "An object representing the task definition for an Extractive Summarization task.", - "properties": { - "taskName": { - "type": "string" - }, - "parameters": { - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - }, - { - "$ref": "#/definitions/PreBuiltTaskParameters" - }, - { - "$ref": "#/definitions/ExtractiveSummarizationTaskParameters" - } - ] - } - } - }, - "ExtractiveSummarizationTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/ExtractiveSummarizationResult" - } - } - }, - "ExtractiveSummarizationResult": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - }, - { - "$ref": "#/definitions/ExtractedSummaryDocuments" - } - ] - }, - "ExtractedSummaryDocuments": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by record", - "items": { - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - }, - { - "$ref": "#/definitions/ExtractedSummaryDocumentResult" - } - ] - } - } - }, - "required": [ - "documents" - ] - }, - "ExtractedSummaryDocumentResult": { - "type": "object", - "required": [ - "sentences" - ], - "properties": { - "sentences": { - "type": "array", - "description": "A ranked list of sentences representing the extracted summary.", - "items": { - "$ref": "#/definitions/ExtractedSummarySentence" - } - } - } - }, - "ExtractedSummarySentence": { - "type": "object", - "required": [ - "text", - "rankScore", - "offset", - "length" - ], - "properties": { - "text": { - "type": "string", - "description": "The extracted sentence text." - }, - "rankScore": { - "type": "number", - "format": "double", - "description": "A double value representing the relevance of the sentence within the summary. Higher values indicate higher importance." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The sentence offset from the start of the record, based on the value of the parameter StringIndexType." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the sentence." - } - } - }, - "KeyPhraseTask": { - "type": "object", - "description": "An object representing the task definition for a Key Phrase Extraction task.", - "properties": { - "taskName": { - "type": "string" - }, - "parameters": { - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - }, - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - } - } - }, - "KeyPhraseTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/KeyPhraseResult" - } - } - }, - "KeyPhraseResult": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - }, - { - "$ref": "#/definitions/KeyPhraseDocuments" - } - ] - }, - "KeyPhraseDocuments": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - }, - { - "$ref": "#/definitions/KeyPhraseDocumentResult" - } - ] - } - } - }, - "required": [ - "documents" - ] - }, - "KeyPhraseDocumentResult": { - "type": "object", - "required": [ - "keyPhrases" - ], - "properties": { - "keyPhrases": { - "type": "array", - "description": "A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input record.", - "items": { - "type": "string" - } - } - } - }, - "AnalyzeTextJobState": { - "allOf": [ - { - "$ref": "#/definitions/JobState" - }, - { - "$ref": "#/definitions/TasksState" - }, - { - "$ref": "#/definitions/AnalyzeTextJobStatistics" - } - ] - }, - "Pagination": { - "properties": { - "nextLink": { - "type": "string" - } - }, - "type": "object" - }, - "JobMetadata": { - "properties": { - "displayName": { - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "type": "string" - }, - "jobId": { - "format": "uuid", - "type": "string" - }, - "lastUpdateDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": false, - "name": "State" - } - } - }, - "required": [ - "jobId", - "lastUpdateDateTime", - "createdDateTime", - "status" - ], - "type": "object" - }, - "JobState": { - "allOf": [ - { - "$ref": "#/definitions/JobMetadata" - }, - { - "$ref": "#/definitions/JobErrors" - }, - { - "$ref": "#/definitions/Pagination" - } - ] - }, - "JobErrors": { - "properties": { - "errors": { - "items": { - "$ref": "#/definitions/Error" - }, - "type": "array" - } - }, - "type": "object" - }, - "AnalyzeTextJobStatistics": { - "properties": { - "statistics": { - "$ref": "#/definitions/RequestStatistics" - } - }, - "type": "object" - }, - "TasksState": { - "properties": { - "tasks": { - "properties": { - "completed": { - "type": "integer" - }, - "failed": { - "type": "integer" - }, - "inProgress": { - "type": "integer" - }, - "total": { - "type": "integer" - }, - "customEntityRecognitionTasks": { - "type": "array", - "items": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TaskState" - }, - { - "$ref": "#/definitions/CustomEntitiesTaskResult" - } - ] - } - }, - "customSingleClassificationTasks": { - "type": "array", - "items": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TaskState" - }, - { - "$ref": "#/definitions/CustomSingleClassificationTaskResult" - } - ] - } - }, - "customMultiClassificationTasks": { - "type": "array", - "items": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TaskState" - }, - { - "$ref": "#/definitions/CustomMultiClassificationTaskResult" - } - ] - } - }, - "entityRecognitionTasks": { - "type": "array", - "items": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TaskState" - }, - { - "$ref": "#/definitions/EntitiesTaskResult" - } - ] - } - }, - "entityRecognitionPiiTasks": { - "type": "array", - "items": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TaskState" - }, - { - "$ref": "#/definitions/PiiTaskResult" - } - ] - } - }, - "keyPhraseExtractionTasks": { - "type": "array", - "items": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TaskState" - }, - { - "$ref": "#/definitions/KeyPhraseTaskResult" - } - ] - } - }, - "entityLinkingTasks": { - "type": "array", - "items": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TaskState" - }, - { - "$ref": "#/definitions/EntityLinkingTaskResult" - } - ] - } - }, - "sentimentAnalysisTasks": { - "type": "array", - "items": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TaskState" - }, - { - "$ref": "#/definitions/SentimentTaskResult" - } - ] - } - }, - "extractiveSummarizationTasks": { - "type": "array", - "items": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TaskState" - }, - { - "$ref": "#/definitions/ExtractiveSummarizationTaskResult" - } - ] - } - } - }, - "required": [ - "total", - "completed", - "failed", - "inProgress" - ], - "type": "object" - } - }, - "required": [ - "tasks" - ], - "type": "object" - }, - "TaskState": { - "properties": { - "lastUpdateDateTime": { - "format": "date-time", - "type": "string" - }, - "taskName": { - "type": "string" - }, - "status": { - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "rejected", - "cancelled", - "cancelling" - ], - "x-ms-enum": { - "modelAsString": false, - "name": "State" - } - } - }, - "required": [ - "status", - "lastUpdateDateTime", - "taskName" - ], - "type": "object" - }, - "StringIndexType": { - "type": "string", - "description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.", - "default": "TextElements_v8", - "enum": [ - "TextElements_v8", - "UnicodeCodePoint", - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "TextElements_v8", - "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." - }, - { - "value": "UnicodeCodePoint", - "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." - }, - { - "value": "Utf16CodeUnit", - "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - } - }, - "DocumentResult": { - "type": "object", - "required": [ - "id", - "warnings" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique, non-empty record identifier." - }, - "warnings": { - "type": "array", - "description": "Warnings encountered while processing record.", - "items": { - "$ref": "#/definitions/DocumentWarning" - } - }, - "statistics": { - "description": "if showStats=true was specified in the request this field will contain information about the record payload.", - "$ref": "#/definitions/DocumentStatistics" - } - } - }, - "DocumentError": { - "type": "object", - "required": [ - "id", - "error" - ], - "properties": { - "id": { - "type": "string", - "description": "Document Id." - }, - "error": { - "type": "object", - "description": "Document Error.", - "$ref": "#/definitions/Error" - } - } - }, - "DocumentWarning": { - "type": "object", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "LongWordsInDocument", - "DocumentTruncated" - ], - "x-ms-enum": { - "name": "WarningCodeValue", - "modelAsString": true - }, - "description": "Error code." - }, - "message": { - "type": "string", - "description": "Warning message." - }, - "targetRef": { - "type": "string", - "description": "A JSON pointer reference indicating the target object." - } - } - }, - "DocumentStatistics": { - "type": "object", - "required": [ - "charactersCount", - "transactionsCount" - ], - "properties": { - "charactersCount": { - "type": "integer", - "format": "int32", - "description": "Number of text elements recognized in the record." - }, - "transactionsCount": { - "type": "integer", - "format": "int32", - "description": "Number of transactions for the record." - } - }, - "description": "if showStats=true was specified in the request this field will contain information about the record payload." - }, - "RequestStatistics": { - "type": "object", - "required": [ - "documentsCount", - "validDocumentsCount", - "erroneousDocumentsCount", - "transactionsCount" - ], - "properties": { - "documentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of documents submitted in the request." - }, - "validDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." - }, - "erroneousDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." - }, - "transactionsCount": { - "type": "integer", - "format": "int64", - "description": "Number of transactions for the request." - } - }, - "description": "if showStats=true was specified in the request this field will contain information about the request payload." - }, - "MultiLanguageBatchInput": { - "type": "object", - "description": "Contains a set of input documents to be analyzed by the service.", - "required": [ - "documents" - ], - "properties": { - "documents": { - "type": "array", - "description": "The set of documents to process as part of this batch.", - "items": { - "$ref": "#/definitions/MultiLanguageInput" - } - } - } - }, - "MultiLanguageInput": { - "type": "object", - "description": "Contains an input record to be analyzed by the service.", - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "A unique, non-empty record identifier." - }, - "text": { - "type": "string", - "description": "The input text to process." - }, - "language": { - "type": "string", - "description": "(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." - } - } - }, - "ErrorResponse": { - "type": "object", - "description": "Error response.", - "properties": { - "error": { - "description": "The error object.", - "$ref": "#/definitions/Error" - } - } - }, - "Error": { - "type": "object", - "description": "The error object.", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "common.json#/definitions/ErrorCode" - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - }, - "target": { - "type": "string", - "description": "The target of the error." - }, - "details": { - "type": "array", - "description": "An array of details about specific errors that led to this reported error.", - "items": { - "$ref": "#/definitions/Error" - } - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "InnerErrorModel": { - "type": "object", - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", - "additionalProperties": false, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "common.json#/definitions/InnerErrorCode" - }, - "message": { - "type": "string", - "description": "Error message." - }, - "details": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Error details." - }, - "target": { - "type": "string", - "description": "Error target." - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - } - }, - "parameters": { - "Endpoint": { - "name": "Endpoint", - "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - }, - "ShowStats": { - "name": "showStats", - "in": "query", - "description": "(Optional) if set to true, response will contain request and record level statistics.", - "type": "boolean", - "required": false, - "x-ms-parameter-location": "method" - }, - "JobId": { - "description": "Job ID", - "format": "uuid", - "in": "path", - "name": "jobId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/common.json b/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/common.json deleted file mode 100644 index 31edd52e3056..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/common.json +++ /dev/null @@ -1,248 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2021-11-01-preview" - }, - "paths": {}, - "definitions": { - "ErrorResponse": { - "type": "object", - "description": "Error response.", - "additionalProperties": false, - "properties": { - "error": { - "description": "The error object.", - "$ref": "#/definitions/Error" - } - }, - "required": [ - "error" - ] - }, - "Error": { - "type": "object", - "description": "The error object.", - "additionalProperties": false, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/ErrorCode" - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - }, - "target": { - "type": "string", - "description": "The target of the error." - }, - "details": { - "type": "array", - "description": "An array of details about specific errors that led to this reported error.", - "items": { - "$ref": "#/definitions/Error" - } - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "InnerErrorModel": { - "type": "object", - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", - "additionalProperties": false, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/InnerErrorCode" - }, - "message": { - "type": "string", - "description": "Error message." - }, - "details": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Error details." - }, - "target": { - "type": "string", - "description": "Error target." - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "ErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "ErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidArgument", - "Unauthorized", - "Forbidden", - "NotFound", - "TooManyRequests", - "InternalServerError", - "ServiceUnavailable", - "ProjectNotFound", - "OperationNotFound", - "AzureCognitiveSearchNotFound", - "AzureCognitiveSearchIndexNotFound", - "AzureCognitiveSearchThrottling", - "AzureCognitiveSearchIndexLimitReached" - ] - }, - "InnerErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "InnerErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidParameterValue", - "KnowledgeBaseNotFound", - "AzureCognitiveSearchNotFound", - "AzureCognitiveSearchThrottling", - "ExtractionFailure", - "InvalidRequestBodyFormat", - "EmptyRequest", - "MissingInputDocuments", - "InvalidDocument", - "ModelVersionIncorrect", - "InvalidDocumentBatch", - "UnsupportedLanguageCode", - "InvalidCountryHint" - ] - }, - "Language": { - "type": "string", - "description": "Language of the text records. This is BCP-47 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." - }, - "StringIndexType": { - "type": "string", - "description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.", - "default": "TextElements_v8", - "enum": [ - "TextElements_v8", - "UnicodeCodePoint", - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "TextElements_v8", - "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." - }, - { - "value": "UnicodeCodePoint", - "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." - }, - { - "value": "Utf16CodeUnit", - "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - } - } - }, - "parameters": { - "Endpoint": { - "name": "Endpoint", - "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - "ProjectNameQueryParameter": { - "name": "projectName", - "in": "query", - "required": true, - "type": "string", - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "ProjectNamePathParameter": { - "name": "projectName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 100, - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNameQueryParameter": { - "name": "deploymentName", - "in": "query", - "required": true, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNamePathParameter": { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - }, - "TopParameter": { - "name": "top", - "in": "query", - "description": "The maximum number of resources to return from the collection.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "SkipParameter": { - "name": "skip", - "in": "query", - "description": "An offset into the collection of the first resource to be returned.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "MaxPageSizeParameter": { - "name": "maxpagesize", - "in": "query", - "description": "The maximum number of resources to include in a single response.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/examples/SuccessfulAnalyzeTextJobStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/examples/SuccessfulAnalyzeTextJobStatusRequest.json deleted file mode 100644 index 33174216e84a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/examples/SuccessfulAnalyzeTextJobStatusRequest.json +++ /dev/null @@ -1,131 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2021-11-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Extracting Location & US Region", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 2, - "failed": 0, - "inProgress": 0, - "total": 2, - "entityRecognitionTasks": [ - { - "taskName": "Recognize Entities", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "entities": [ - { - "category": "Event", - "confidenceScore": 0.61, - "length": 4, - "offset": 18, - "text": "trip" - }, - { - "category": "Location", - "confidenceScore": 0.82, - "length": 7, - "offset": 26, - "subcategory": "GPE", - "text": "Seattle" - }, - { - "category": "DateTime", - "confidenceScore": 0.8, - "length": 9, - "offset": 34, - "subcategory": "DateRange", - "text": "last week" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "Location", - "confidenceScore": 0.52, - "length": 3, - "offset": 14, - "subcategory": "GPE", - "text": "NYC" - }, - { - "category": "DateTime", - "confidenceScore": 0.8, - "length": 8, - "offset": 18, - "subcategory": "Date", - "text": "tomorrow" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-04-01" - } - } - ], - "customEntityRecognitionTasks": [ - { - "taskName": "Recognize US Regions", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "entities": [ - { - "category": "USRegion", - "confidenceScore": 0.85, - "length": 17, - "offset": 45, - "text": "Pacific Northwest" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "USRegion", - "confidenceScore": 0.88, - "length": 10, - "offset": 63, - "text": "East Coast" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "projectName": "MyProject", - "deploymentName": "MyDeployment" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/examples/SuccessfulAnalyzeTextJobSubmitRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/examples/SuccessfulAnalyzeTextJobSubmitRequest.json deleted file mode 100644 index d9337904566d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/examples/SuccessfulAnalyzeTextJobSubmitRequest.json +++ /dev/null @@ -1,51 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2021-11-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "input": { - "displayName": "Extracting Location & US Region", - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "I had a wonderful trip to Seattle last week. The Pacific Northwest is beautiful." - }, - { - "id": "2", - "language": "en", - "text": "I'm flying to NYC tomorrow. I hear the weather is cold on the East Coast this time of year. Should I bring a heavy coat?" - } - ] - }, - "tasks": { - "entityRecognitionTasks": [ - { - "taskName": "Recognize Entities", - "parameters": { - "model-version": "latest" - } - } - ], - "customEntityRecognitionTasks": [ - { - "taskName": "Recognize US Regions", - "parameters": { - "projectName": "MyProject", - "deploymentName": "MyDeployment" - } - } - ] - } - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/examples/conversations/Conversation_project.json b/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/examples/conversations/Conversation_project.json deleted file mode 100644 index e0844baf3a1f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/examples/conversations/Conversation_project.json +++ /dev/null @@ -1,78 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-11-01-preview", - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "ConversationAnalysisOptions": { - "query": "play a song", - "language": "en-us", - "verbose": true, - "isLoggingEnabled": false - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "query": "play a song from Joe Doe", - "detectedLanguage": "en-Us", - "prediction": { - "topIntent": "PlayMusic", - "projectKind": "conversation", - "intents": [ - { - "category": "PlayMusic", - "confidenceScore": 0.99998415 - }, - { - "category": "SearchCreativeWork", - "confidenceScore": 0.000008943313 - }, - { - "category": "BookRestaurant", - "confidenceScore": 0.0000041524872 - }, - { - "category": "GetWeather", - "confidenceScore": 0.0000011409703 - }, - { - "category": "AddToPlaylist", - "confidenceScore": 0.0000010632801 - }, - { - "category": "SearchScreeningEvent", - "confidenceScore": 3.2717122e-7 - }, - { - "category": "RateBook", - "confidenceScore": 1.926987e-7 - } - ], - "entities": [ - { - "category": "music_item", - "text": "song", - "offset": 7, - "length": 4, - "confidenceScore": 0.9959329 - }, - { - "category": "artist", - "text": "Joe", - "offset": 17, - "length": 7, - "confidenceScore": 0.99691725, - "listKeys": [ - "Joe D." - ] - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/examples/conversations/Orchestrator_arbitration.json b/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/examples/conversations/Orchestrator_arbitration.json deleted file mode 100644 index 258e906824fa..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/examples/conversations/Orchestrator_arbitration.json +++ /dev/null @@ -1,91 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-11-01-preview", - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "ConversationAnalysisOptions": { - "query": "How do I integrate QnA Maker and LUIS?" - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "query": "How do I integrate QnA Maker and LUIS?", - "prediction": { - "projectKind": "workflow", - "topIntent": "qnaTargetApp", - "intents": { - "qnaTargetApp": { - "targetKind": "question_answering", - "apiVersion": "2021-05-01-preview", - "confidenceScore": 0.913329, - "result": { - "answers": [ - { - "questions": [ - "Power and charging" - ], - "answer": "Power and charging**\n\nIt takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you are using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.\n\nYou can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface.", - "confidenceScore": 0.65, - "id": 20, - "source": "surface-pro-4-user-guide-EN.pdf", - "metadata": { - "category": "api", - "editorial": "chitchat" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 23, - "displayText": "prompt1" - }, - { - "displayOrder": 2, - "qnaId": 36, - "displayText": "prompt2" - } - ] - }, - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0.3, - "offset": 33, - "length": 50 - } - }, - { - "questions": [ - "Charge your Surface Pro 4" - ], - "answer": "**Charge your Surface Pro 4**\n\n1. Connect the two parts of the power cord.\n\n2. Connect the power cord securely to the charging port.\n\n3. Plug the power supply into an electrical outlet.", - "confidenceScore": 0.32, - "id": 13, - "source": "surface-pro-4-user-guide-EN.pdf" - } - ] - } - }, - "mcluApp": { - "targetKind": "conversation", - "confidenceScore": 0.082329 - }, - "luisApp": { - "targetKind": "luis", - "confidenceScore": 0.001 - }, - "nonlinkedIntent1": { - "targetKind": "non_linked", - "confidenceScore": 0.00021 - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/examples/conversations/Orchestrator_direct_target.json b/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/examples/conversations/Orchestrator_direct_target.json deleted file mode 100644 index 770562719047..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/examples/conversations/Orchestrator_direct_target.json +++ /dev/null @@ -1,96 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-11-01-preview", - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "ConversationAnalysisOptions": { - "query": "", - "directTarget": "qnaTargetApp", - "parameters": { - "qnaTargetApp": { - "targetKind": "question_answering", - "apiVersion": "v5.1", - "callingOptions": { - "question": "Ports and connectors", - "top": 3, - "userId": "Default", - "isTest": true, - "context": { - "previousQuery": "Meet Surface Pro 4", - "previousQnAId": 4 - } - } - } - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "query": "Ports and connectors", - "prediction": { - "projectKind": "workflow", - "topIntent": "qnaTargetApp", - "intents": { - "qnaTargetApp": { - "targetKind": "question_answering", - "apiVersion": "v5.1", - "confidenceScore": 0.913329, - "result": { - "answers": [ - { - "questions": [ - "Power and charging" - ], - "answer": "Power and charging**\n\nIt takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you are using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.\n\nYou can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface.", - "confidenceScore": 0.65, - "id": 20, - "source": "surface-pro-4-user-guide-EN.pdf", - "metadata": { - "category": "api", - "editorial": "chitchat" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 23, - "displayText": "prompt1" - }, - { - "displayOrder": 2, - "qnaId": 36, - "displayText": "prompt2" - } - ] - }, - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0.3, - "offset": 33, - "length": 50 - } - }, - { - "questions": [ - "Charge your Surface Pro 4" - ], - "answer": "**Charge your Surface Pro 4**\n\n1. Connect the two parts of the power cord.\n\n2. Connect the power cord securely to the charging port.\n\n3. Plug the power supply into an electrical outlet.", - "confidenceScore": 0.32, - "id": 13, - "source": "surface-pro-4-user-guide-EN.pdf" - } - ] - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/oav b/specification/cognitiveservices/data-plane/Language/preview/2021-11-01-preview/oav deleted file mode 100644 index e69de29bb2d1..000000000000 diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/analyzetext.json b/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/analyzetext.json deleted file mode 100644 index a0d3e4b80e82..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/analyzetext.json +++ /dev/null @@ -1,2851 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Text Analysis", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview.0", - "version": "2022-02-01-preview" - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/:analyze-text": { - "post": { - "summary": "Request text analysis over a collection of documents.", - "description": "Submit a collection of text documents for analysis. Specify a single unique task to be executed immediately.", - "operationId": "AnalyzeText", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ShowStats" - }, - { - "description": "Collection of documents to analyze and a single task to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeTextTask" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "A successful call result", - "schema": { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Entity Linking Request": { - "$ref": "./examples/SuccessfulEntityLinkingRequest.json" - }, - "Successful Entity Recognition Request": { - "$ref": "./examples/SuccessfulEntityRecognitionRequest.json" - }, - "Successful Key Phrase Extraction Request": { - "$ref": "./examples/SuccessfulKeyPhraseExtractionRequest.json" - }, - "Successful PII Entity Recognition Request": { - "$ref": "./examples/SuccessfulPiiEntityRecognitionRequest.json" - }, - "Successful Language Detection Request": { - "$ref": "./examples/SuccessfulLanguageDetectionRequest.json" - }, - "Successful Sentiment Analysis Request": { - "$ref": "./examples/SuccessfulSentimentAnalysisRequest.json" - } - } - } - }, - "/analyze-text/jobs": { - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "description": "Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.", - "operationId": "AnalyzeText_SubmitJob", - "summary": "Submit text analysis job", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Collection of documents to analyze and one or more tasks to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeTextJobsInput" - }, - "required": true - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Submit Analysis Job Request": { - "$ref": "./examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/analyze-text/jobs/{jobId}": { - "get": { - "produces": [ - "application/json" - ], - "description": "Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are succeeded, the job will transition to the succeeded state and results will be available for each task.", - "operationId": "AnalyzeText_JobStatus", - "summary": "Get analysis status and results", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobId" - }, - { - "$ref": "#/parameters/ShowStats" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - } - ], - "responses": { - "200": { - "description": "Analysis job status and metadata.", - "schema": { - "$ref": "#/definitions/AnalyzeTextJobState" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Text Analysis Job Status Request": { - "$ref": "./examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json" - } - } - } - } - }, - "definitions": { - "AnalyzeTextTaskKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis tasks.", - "enum": [ - "SentimentAnalysis", - "EntityRecognition", - "PiiEntityRecognition", - "KeyPhraseExtraction", - "LanguageDetection", - "EntityLinking" - ], - "x-ms-enum": { - "name": "AnalyzeTextTaskKind", - "modelAsString": true - } - }, - "AnalyzeTextLROTaskKind": { - "type": "string", - "description": "Enumeration of supported long-running Text Analysis tasks.", - "enum": [ - "SentimentAnalysis", - "EntityRecognition", - "PiiEntityRecognition", - "KeyPhraseExtraction", - "EntityLinking", - "Healthcare", - "ExtractiveSummarization", - "CustomEntityRecognition", - "CustomSingleClassification", - "CustomMultiClassification" - ], - "x-ms-enum": { - "name": "AnalyzeTextLROTaskKind", - "modelAsString": true - } - }, - "AnalyzeTextTaskResultsKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis task results.", - "enum": [ - "SentimentAnalysisResults", - "EntityRecognitionResults", - "PiiEntityRecognitionResults", - "KeyPhraseExtractionResults", - "LanguageDetectionResults", - "EntityLinkingResults" - ], - "x-ms-enum": { - "name": "AnalyzeTextTaskResultsKind", - "modelAsString": true - } - }, - "AnalyzeTextLROResultsKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis long-running operation task results.", - "enum": [ - "SentimentAnalysisLROResults", - "EntityRecognitionLROResults", - "PiiEntityRecognitionLROResults", - "KeyPhraseExtractionLROResults", - "EntityLinkingLROResults", - "HealthcareLROResults", - "ExtractiveSummarizationLROResults", - "CustomEntityRecognitionLROResults", - "CustomSingleClassificationLROResults", - "CustomMultiClassificationLROResults" - ], - "x-ms-enum": { - "name": "AnalyzeTextLROResultsKind", - "modelAsString": true - } - }, - "MultiLanguageAnalysisInput": { - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/definitions/MultiLanguageInput" - } - } - } - }, - "LanguageDetectionAnalysisInput": { - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/definitions/LanguageInput" - } - } - } - }, - "AnalyzeTextTask": { - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextTaskKind" - } - } - }, - "AnalyzeTextLROTask": { - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextLROTaskKind" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskIdentifier" - } - ] - }, - "AnalyzeTextTaskResult": { - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextTaskResultsKind" - } - } - }, - "AnalyzeTextEntityLinkingInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/EntityLinkingTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "EntityLinking" - }, - "AnalyzeTextEntityRecognitionInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/EntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "EntityRecognition" - }, - "AnalyzeTextKeyPhraseExtractionInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/KeyPhraseTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "KeyPhraseExtraction" - }, - "AnalyzeTextPiiEntitiesRecognitionInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/PiiTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "PiiEntityRecognition" - }, - "AnalyzeTextLanguageDetectionInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/LanguageDetectionAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/LanguageDetectionTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "LanguageDetection" - }, - "AnalyzeTextSentimentAnalysisInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/SentimentAnalysisTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "SentimentAnalysis" - }, - "AnalyzeTextJobsInput": { - "properties": { - "displayName": { - "description": "Optional display name for the analysis job.", - "type": "string" - }, - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "tasks": { - "description": "The set of tasks to execute on the input documents.", - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - } - }, - "required": [ - "analysisInput", - "tasks" - ] - }, - "TaskIdentifier": { - "type": "object", - "description": "Base task object.", - "properties": { - "taskName": { - "type": "string" - } - } - }, - "TaskParameters": { - "type": "object", - "description": "Base parameters object for a text analysis task.", - "properties": { - "loggingOptOut": { - "type": "boolean", - "default": false - } - } - }, - "PreBuiltTaskParameters": { - "type": "object", - "description": "Parameters object for a text analysis task using pre-built models.", - "properties": { - "modelVersion": { - "type": "string", - "default": "latest" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - } - ] - }, - "PreBuiltResult": { - "properties": { - "errors": { - "type": "array", - "description": "Errors by document id.", - "items": { - "$ref": "#/definitions/DocumentError" - } - }, - "statistics": { - "$ref": "#/definitions/RequestStatistics" - }, - "modelVersion": { - "type": "string", - "description": "This field indicates which model is used for scoring." - } - }, - "required": [ - "errors", - "modelVersion" - ] - }, - "CustomTaskParameters": { - "type": "object", - "description": "Parameters object for a text analysis task using custom models.", - "properties": { - "projectName": { - "type": "string" - }, - "deploymentName": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - } - ], - "required": [ - "projectName", - "deploymentName" - ] - }, - "CustomResult": { - "properties": { - "errors": { - "type": "array", - "description": "Errors by document id.", - "items": { - "$ref": "#/definitions/DocumentError" - } - }, - "statistics": { - "$ref": "#/definitions/RequestStatistics" - }, - "projectName": { - "type": "string", - "description": "This field indicates the project name for the model." - }, - "deploymentName": { - "type": "string", - "description": "This field indicates the deployment name for the model." - } - }, - "required": [ - "errors", - "projectName", - "deploymentName" - ] - }, - "CustomEntitiesTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Entities task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/CustomTaskParameters" - } - ] - }, - "CustomEntitiesLROTask": { - "type": "object", - "description": "Use custom models to ease the process of information extraction from unstructured documents like contracts or financial documents", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomEntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomEntityRecognition" - }, - "CustomEntitiesResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/EntitiesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/CustomResult" - } - ], - "required": [ - "documents" - ] - }, - "CustomSingleClassificationTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Single Classification task.", - "allOf": [ - { - "$ref": "#/definitions/CustomTaskParameters" - } - ] - }, - "CustomSingleClassificationLROTask": { - "type": "object", - "description": "Use custom models to classify text into single label taxonomy", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomSingleClassificationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomSingleClassification" - }, - "CustomSingleClassificationResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/SingleClassificationDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/CustomResult" - } - ], - "required": [ - "documents" - ] - }, - "SingleClassificationDocumentResult": { - "type": "object", - "properties": { - "classification": { - "$ref": "#/definitions/ClassificationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "classification" - ] - }, - "ClassificationResult": { - "type": "object", - "required": [ - "category", - "confidenceScore" - ], - "properties": { - "category": { - "type": "string", - "description": "Classification type." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the recognized classification." - } - } - }, - "CustomMultiClassificationTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Multi Classification task.", - "allOf": [ - { - "$ref": "#/definitions/CustomTaskParameters" - } - ] - }, - "CustomMultiClassificationLROTask": { - "type": "object", - "description": "Use custom models to classify text into multi label taxonomy", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomMultiClassificationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomMultiClassification" - }, - "CustomMultiClassificationResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/MultiClassificationDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/CustomResult" - } - ], - "required": [ - "documents" - ] - }, - "MultiClassificationDocumentResult": { - "type": "object", - "properties": { - "classifications": { - "type": "array", - "items": { - "$ref": "#/definitions/ClassificationResult" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "classifications" - ] - }, - "HealthcareTaskParameters": { - "type": "object", - "description": "Supported parameters for a Healthcare task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - }, - "HealthcareLROTask": { - "type": "object", - "properties": { - "parameters": { - "$ref": "#/definitions/HealthcareTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "Healthcare" - }, - "HealthcareResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "#/definitions/HealthcareEntitiesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "HealthcareEntitiesDocumentResult": { - "type": "object", - "properties": { - "entities": { - "description": "Healthcare entities.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareEntity" - } - }, - "relations": { - "type": "array", - "description": "Healthcare entity relations.", - "items": { - "$ref": "#/definitions/HealthcareRelation" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "entities", - "relations" - ] - }, - "HealthcareEntity": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "x-ms-enum": { - "name": "healthcareEntityCategory", - "modelAsString": true - }, - "type": "string", - "description": "Healthcare Entity Category.", - "enum": [ - "BODY_STRUCTURE", - "AGE", - "GENDER", - "EXAMINATION_NAME", - "DATE", - "DIRECTION", - "FREQUENCY", - "MEASUREMENT_VALUE", - "MEASUREMENT_UNIT", - "RELATIONAL_OPERATOR", - "TIME", - "GENE_OR_PROTEIN", - "VARIANT", - "ADMINISTRATIVE_EVENT", - "CARE_ENVIRONMENT", - "HEALTHCARE_PROFESSION", - "DIAGNOSIS", - "SYMPTOM_OR_SIGN", - "CONDITION_QUALIFIER", - "MEDICATION_CLASS", - "MEDICATION_NAME", - "DOSAGE", - "MEDICATION_FORM", - "MEDICATION_ROUTE", - "FAMILY_RELATION", - "TREATMENT_NAME" - ] - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub type." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted entity." - }, - "assertion": { - "type": "object", - "$ref": "#/definitions/HealthcareAssertion" - }, - "name": { - "description": "Preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'.", - "type": "string" - }, - "links": { - "description": "Entity references in known data sources.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareEntityLink" - } - } - }, - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ] - }, - "HealthcareRelation": { - "type": "object", - "description": "Every relation is an entity graph of a certain relationType, where all entities are connected and have specific roles within the relation context.", - "required": [ - "relationType", - "entities" - ], - "properties": { - "relationType": { - "description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc.", - "type": "string", - "enum": [ - "Abbreviation", - "DirectionOfBodyStructure", - "DirectionOfCondition", - "DirectionOfExamination", - "DirectionOfTreatment", - "DosageOfMedication", - "FormOfMedication", - "FrequencyOfMedication", - "FrequencyOfTreatment", - "QualifierOfCondition", - "RelationOfExamination", - "RouteOfMedication", - "TimeOfCondition", - "TimeOfEvent", - "TimeOfExamination", - "TimeOfMedication", - "TimeOfTreatment", - "UnitOfCondition", - "UnitOfExamination", - "ValueOfCondition", - "ValueOfExamination" - ], - "x-ms-enum": { - "name": "relationType", - "modelAsString": true - } - }, - "entities": { - "description": "The entities in the relation.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareRelationEntity" - } - } - } - }, - "HealthcareAssertion": { - "type": "object", - "properties": { - "conditionality": { - "description": "Describes any conditionality on the entity.", - "type": "string", - "enum": [ - "hypothetical", - "conditional" - ], - "x-ms-enum": { - "name": "Conditionality", - "modelAsString": false - } - }, - "certainty": { - "description": "Describes the entities certainty and polarity.", - "type": "string", - "enum": [ - "positive", - "positivePossible", - "neutralPossible", - "negativePossible", - "negative" - ], - "x-ms-enum": { - "name": "Certainty", - "modelAsString": false - } - }, - "association": { - "description": "Describes if the entity is the subject of the text or if it describes someone else.", - "type": "string", - "enum": [ - "subject", - "other" - ], - "x-ms-enum": { - "name": "Association", - "modelAsString": false - } - } - } - }, - "HealthcareRelationEntity": { - "type": "object", - "required": [ - "ref", - "role" - ], - "properties": { - "ref": { - "description": "Reference link object, using a JSON pointer RFC 6901 (URI Fragment Identifier Representation), pointing to the entity .", - "type": "string" - }, - "role": { - "description": "Role of entity in the relationship. For example: 'CD20-positive diffuse large B-cell lymphoma' has the following entities with their roles in parenthesis: CD20 (GeneOrProtein), Positive (Expression), diffuse large B-cell lymphoma (Diagnosis).", - "type": "string" - } - } - }, - "HealthcareEntityLink": { - "type": "object", - "required": [ - "dataSource", - "id" - ], - "properties": { - "dataSource": { - "description": "Entity Catalog. Examples include: UMLS, CHV, MSH, etc.", - "type": "string" - }, - "id": { - "description": "Entity id in the given source catalog.", - "type": "string" - } - } - }, - "SentimentAnalysisTaskParameters": { - "type": "object", - "description": "Supported parameters for a Sentiment Analysis task.", - "properties": { - "opinionMining": { - "type": "boolean", - "default": false - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - }, - "SentimentAnalysisLROTask": { - "type": "object", - "description": "An object representing the task definition for a Sentiment Analysis task.", - "properties": { - "parameters": { - "$ref": "#/definitions/SentimentAnalysisTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "SentimentAnalysis" - }, - "SentimentTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/SentimentResponse" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "SentimentAnalysisResults" - }, - "SentimentResponse": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Sentiment analysis per document.", - "items": { - "allOf": [ - { - "$ref": "#/definitions/SentimentDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "SentimentDocumentResult": { - "type": "object", - "properties": { - "sentiment": { - "type": "string", - "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).", - "enum": [ - "positive", - "neutral", - "negative", - "mixed" - ], - "x-ms-enum": { - "name": "DocumentSentimentValue", - "modelAsString": false - } - }, - "confidenceScores": { - "description": "Document level sentiment confidence scores between 0 and 1 for each sentiment class.", - "$ref": "#/definitions/SentimentConfidenceScorePerLabel" - }, - "sentences": { - "type": "array", - "description": "Sentence level sentiment analysis.", - "items": { - "$ref": "#/definitions/SentenceSentiment" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "sentiment", - "confidenceScores", - "sentences" - ] - }, - "SentimentConfidenceScorePerLabel": { - "type": "object", - "required": [ - "positive", - "neutral", - "negative" - ], - "properties": { - "positive": { - "type": "number", - "format": "double" - }, - "neutral": { - "type": "number", - "format": "double" - }, - "negative": { - "type": "number", - "format": "double" - } - }, - "description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative." - }, - "SentenceSentiment": { - "type": "object", - "required": [ - "text", - "sentiment", - "confidenceScores", - "offset", - "length" - ], - "properties": { - "text": { - "type": "string", - "description": "The sentence text." - }, - "sentiment": { - "type": "string", - "description": "The predicted Sentiment for the sentence.", - "enum": [ - "positive", - "neutral", - "negative" - ], - "x-ms-enum": { - "name": "SentenceSentimentValue", - "modelAsString": false - } - }, - "confidenceScores": { - "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes.", - "$ref": "#/definitions/SentimentConfidenceScorePerLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The sentence offset from the start of the document." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the sentence." - }, - "targets": { - "type": "array", - "description": "The array of sentence targets for the sentence.", - "items": { - "$ref": "#/definitions/SentenceTarget" - } - }, - "assessments": { - "type": "array", - "description": "The array of assessments for the sentence.", - "items": { - "$ref": "#/definitions/SentenceAssessment" - } - } - } - }, - "SentenceTarget": { - "type": "object", - "required": [ - "confidenceScores", - "length", - "offset", - "relations", - "sentiment", - "text" - ], - "properties": { - "sentiment": { - "type": "string", - "enum": [ - "positive", - "mixed", - "negative" - ], - "x-ms-enum": { - "name": "TokenSentimentValue", - "modelAsString": false - }, - "description": "Targeted sentiment in the sentence." - }, - "confidenceScores": { - "description": "Target sentiment confidence scores for the target in the sentence.", - "$ref": "#/definitions/TargetConfidenceScoreLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The target offset from the start of the sentence." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the target." - }, - "text": { - "type": "string", - "description": "The target text detected." - }, - "relations": { - "type": "array", - "description": "The array of either assessment or target objects which is related to the target.", - "items": { - "$ref": "#/definitions/TargetRelation" - } - } - } - }, - "SentenceAssessment": { - "type": "object", - "required": [ - "confidenceScores", - "isNegated", - "length", - "offset", - "sentiment", - "text" - ], - "properties": { - "sentiment": { - "type": "string", - "enum": [ - "positive", - "mixed", - "negative" - ], - "x-ms-enum": { - "name": "TokenSentimentValue", - "modelAsString": false - }, - "description": "Assessment sentiment in the sentence." - }, - "confidenceScores": { - "description": "Assessment sentiment confidence scores in the sentence.", - "$ref": "#/definitions/TargetConfidenceScoreLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The assessment offset from the start of the sentence." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the assessment." - }, - "text": { - "type": "string", - "description": "The assessment text detected." - }, - "isNegated": { - "type": "boolean", - "description": "The indicator representing if the assessment is negated." - } - } - }, - "TargetRelation": { - "type": "object", - "required": [ - "ref", - "relationType" - ], - "properties": { - "relationType": { - "type": "string", - "enum": [ - "assessment", - "target" - ], - "x-ms-enum": { - "name": "TargetRelationType", - "modelAsString": false - }, - "description": "The type related to the target." - }, - "ref": { - "type": "string", - "description": "The JSON pointer indicating the linked object." - } - } - }, - "TargetConfidenceScoreLabel": { - "type": "object", - "required": [ - "negative", - "positive" - ], - "properties": { - "positive": { - "type": "number", - "format": "double" - }, - "negative": { - "type": "number", - "format": "double" - } - }, - "description": "Represents the confidence scores across all sentiment classes: positive, neutral, negative." - }, - "EntitiesTaskParameters": { - "type": "object", - "description": "Supported parameters for an Entity Recognition task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - }, - "EntitiesLROTask": { - "type": "object", - "description": "An object representing the task definition for an Entities Recognition task.", - "properties": { - "parameters": { - "$ref": "#/definitions/EntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "EntityRecognition" - }, - "EntitiesTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "x-ms-discriminator-value": "EntityRecognitionResults" - }, - "EntitiesResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/EntitiesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "EntitiesDocumentResult": { - "type": "object", - "properties": { - "entities": { - "type": "array", - "description": "Recognized entities in the document.", - "items": { - "$ref": "#/definitions/Entity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "entities" - ] - }, - "Entity": { - "type": "object", - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ], - "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "type": "string", - "description": "Entity type." - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub type." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted entity." - } - } - }, - "EntityLinkingTaskParameters": { - "type": "object", - "description": "Supported parameters for an Entity Linking task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - }, - "EntityLinkingLROTask": { - "type": "object", - "description": "An object representing the task definition for an Entity Linking task.", - "properties": { - "parameters": { - "$ref": "#/definitions/EntityLinkingTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "EntityLinking" - }, - "EntityLinkingTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntityLinkingResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "x-ms-discriminator-value": "EntityLinkingResults" - }, - "EntityLinkingResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/LinkedEntitiesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "LinkedEntitiesDocumentResult": { - "type": "object", - "required": [ - "entities" - ], - "properties": { - "entities": { - "type": "array", - "description": "Recognized well known entities in the document.", - "items": { - "$ref": "#/definitions/LinkedEntity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ] - }, - "LinkedEntity": { - "type": "object", - "required": [ - "name", - "matches", - "language", - "url", - "dataSource" - ], - "properties": { - "name": { - "type": "string", - "description": "Entity Linking formal name." - }, - "matches": { - "type": "array", - "description": "List of instances this entity appears in the text.", - "items": { - "$ref": "#/definitions/Match" - } - }, - "language": { - "type": "string", - "description": "Language used in the data source." - }, - "id": { - "type": "string", - "description": "Unique identifier of the recognized entity from the data source." - }, - "url": { - "type": "string", - "description": "URL for the entity's page from the data source." - }, - "dataSource": { - "type": "string", - "description": "Data source used to extract entity linking, such as Wiki/Bing etc." - }, - "bingId": { - "type": "string", - "description": "Bing Entity Search API unique identifier of the recognized entity." - } - } - }, - "Match": { - "type": "object", - "required": [ - "confidenceScore", - "text", - "offset", - "length" - ], - "properties": { - "confidenceScore": { - "type": "number", - "format": "double", - "description": "If a well known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned." - }, - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity match text." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity match text." - } - } - }, - "PiiTaskParameters": { - "type": "object", - "description": "Supported parameters for a PII Entities Recognition task.", - "properties": { - "domain": { - "$ref": "#/definitions/PiiDomain" - }, - "piiCategories": { - "$ref": "#/definitions/PiiCategories" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - }, - "PiiLROTask": { - "type": "object", - "description": "An object representing the task definition for a PII Entities Recognition task.", - "properties": { - "parameters": { - "$ref": "#/definitions/PiiTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "PiiEntityRecognition" - }, - "PiiTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/PiiResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "x-ms-discriminator-value": "PiiEntityRecognitionResults" - }, - "PiiResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/PiiEntitiesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "PiiDomain": { - "type": "string", - "description": "The PII domain used for PII Entity Recognition.", - "default": "none", - "enum": [ - "phi", - "none" - ], - "x-ms-enum": { - "name": "PiiDomain", - "modelAsString": true, - "values": [ - { - "name": "phi", - "description": "Indicates that entities in the Personal Health Information domain should be redacted.", - "value": "phi" - }, - { - "name": "none", - "description": "Indicates that no domain is specified.", - "value": "none" - } - ] - } - }, - "PiiEntitiesDocumentResult": { - "type": "object", - "properties": { - "redactedText": { - "type": "string", - "description": "Returns redacted text." - }, - "entities": { - "type": "array", - "description": "Recognized entities in the document.", - "items": { - "$ref": "#/definitions/Entity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "redactedText", - "entities" - ] - }, - "PiiCategories": { - "description": "(Optional) describes the PII categories to return", - "items": { - "type": "string", - "x-ms-enum": { - "name": "PiiCategory", - "modelAsString": true - }, - "enum": [ - "ABARoutingNumber", - "ARNationalIdentityNumber", - "AUBankAccountNumber", - "AUDriversLicenseNumber", - "AUMedicalAccountNumber", - "AUPassportNumber", - "AUTaxFileNumber", - "AUBusinessNumber", - "AUCompanyNumber", - "ATIdentityCard", - "ATTaxIdentificationNumber", - "ATValueAddedTaxNumber", - "AzureDocumentDBAuthKey", - "AzureIAASDatabaseConnectionAndSQLString", - "AzureIoTConnectionString", - "AzurePublishSettingPassword", - "AzureRedisCacheString", - "AzureSAS", - "AzureServiceBusString", - "AzureStorageAccountKey", - "AzureStorageAccountGeneric", - "BENationalNumber", - "BENationalNumberV2", - "BEValueAddedTaxNumber", - "BRCPFNumber", - "BRLegalEntityNumber", - "BRNationalIDRG", - "BGUniformCivilNumber", - "CABankAccountNumber", - "CADriversLicenseNumber", - "CAHealthServiceNumber", - "CAPassportNumber", - "CAPersonalHealthIdentification", - "CASocialInsuranceNumber", - "CLIdentityCardNumber", - "CNResidentIdentityCardNumber", - "CreditCardNumber", - "HRIdentityCardNumber", - "HRNationalIDNumber", - "HRPersonalIdentificationNumber", - "HRPersonalIdentificationOIBNumberV2", - "CYIdentityCard", - "CYTaxIdentificationNumber", - "CZPersonalIdentityNumber", - "CZPersonalIdentityV2", - "DKPersonalIdentificationNumber", - "DKPersonalIdentificationV2", - "DrugEnforcementAgencyNumber", - "EEPersonalIdentificationCode", - "EUDebitCardNumber", - "EUDriversLicenseNumber", - "EUGPSCoordinates", - "EUNationalIdentificationNumber", - "EUPassportNumber", - "EUSocialSecurityNumber", - "EUTaxIdentificationNumber", - "FIEuropeanHealthNumber", - "FINationalID", - "FINationalIDV2", - "FIPassportNumber", - "FRDriversLicenseNumber", - "FRHealthInsuranceNumber", - "FRNationalID", - "FRPassportNumber", - "FRSocialSecurityNumber", - "FRTaxIdentificationNumber", - "FRValueAddedTaxNumber", - "DEDriversLicenseNumber", - "DEPassportNumber", - "DEIdentityCardNumber", - "DETaxIdentificationNumber", - "DEValueAddedNumber", - "GRNationalIDCard", - "GRNationalIDV2", - "GRTaxIdentificationNumber", - "HKIdentityCardNumber", - "HUValueAddedNumber", - "HUPersonalIdentificationNumber", - "HUTaxIdentificationNumber", - "INPermanentAccount", - "INUniqueIdentificationNumber", - "IDIdentityCardNumber", - "InternationalBankingAccountNumber", - "IEPersonalPublicServiceNumber", - "IEPersonalPublicServiceNumberV2", - "ILBankAccountNumber", - "ILNationalID", - "ITDriversLicenseNumber", - "ITFiscalCode", - "ITValueAddedTaxNumber", - "JPBankAccountNumber", - "JPDriversLicenseNumber", - "JPPassportNumber", - "JPResidentRegistrationNumber", - "JPSocialInsuranceNumber", - "JPMyNumberCorporate", - "JPMyNumberPersonal", - "JPResidenceCardNumber", - "LVPersonalCode", - "LTPersonalCode", - "LUNationalIdentificationNumberNatural", - "LUNationalIdentificationNumberNonNatural", - "MYIdentityCardNumber", - "MTIdentityCardNumber", - "MTTaxIDNumber", - "NLCitizensServiceNumber", - "NLCitizensServiceNumberV2", - "NLTaxIdentificationNumber", - "NLValueAddedTaxNumber", - "NZBankAccountNumber", - "NZDriversLicenseNumber", - "NZInlandRevenueNumber", - "NZMinistryOfHealthNumber", - "NZSocialWelfareNumber", - "NOIdentityNumber", - "PHUnifiedMultiPurposeIDNumber", - "PLIdentityCard", - "PLNationalID", - "PLNationalIDV2", - "PLPassportNumber", - "PLTaxIdentificationNumber", - "PLREGONNumber", - "PTCitizenCardNumber", - "PTCitizenCardNumberV2", - "PTTaxIdentificationNumber", - "ROPersonalNumericalCode", - "RUPassportNumberDomestic", - "RUPassportNumberInternational", - "SANationalID", - "SGNationalRegistrationIdentityCardNumber", - "SKPersonalNumber", - "SITaxIdentificationNumber", - "SIUniqueMasterCitizenNumber", - "ZAIdentificationNumber", - "KRResidentRegistrationNumber", - "ESDNI", - "ESSocialSecurityNumber", - "ESTaxIdentificationNumber", - "SQLServerConnectionString", - "SENationalID", - "SENationalIDV2", - "SEPassportNumber", - "SETaxIdentificationNumber", - "SWIFTCode", - "CHSocialSecurityNumber", - "TWNationalID", - "TWPassportNumber", - "TWResidentCertificate", - "THPopulationIdentificationCode", - "TRNationalIdentificationNumber", - "UKDriversLicenseNumber", - "UKElectoralRollNumber", - "UKNationalHealthNumber", - "UKNationalInsuranceNumber", - "UKUniqueTaxpayerNumber", - "USUKPassportNumber", - "USBankAccountNumber", - "USDriversLicenseNumber", - "USIndividualTaxpayerIdentification", - "USSocialSecurityNumber", - "UAPassportNumberDomestic", - "UAPassportNumberInternational", - "Organization", - "Email", - "URL", - "Age", - "PhoneNumber", - "IPAddress", - "Date", - "Person", - "Address", - "All", - "Default" - ] - }, - "type": "array", - "uniqueItems": true - }, - "ExtractiveSummarizationTaskParameters": { - "type": "object", - "description": "Supported parameters for an Extractive Summarization task.", - "properties": { - "sentenceCount": { - "type": "integer", - "default": 3 - }, - "sortBy": { - "$ref": "#/definitions/ExtractiveSummarizationSortingCriteria" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - }, - "ExtractiveSummarizationLROTask": { - "type": "object", - "description": "An object representing the task definition for an Extractive Summarization task.", - "properties": { - "parameters": { - "$ref": "#/definitions/ExtractiveSummarizationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "ExtractiveSummarization" - }, - "ExtractiveSummarizationResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/ExtractedSummaryDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "ExtractiveSummarizationSortingCriteria": { - "type": "string", - "default": "Offset", - "description": "The sorting criteria to use for the results of Extractive Summarization.", - "enum": [ - "Offset", - "Rank" - ], - "x-ms-enum": { - "name": "ExtractiveSummarizationSortingCriteria", - "modelAsString": true, - "values": [ - { - "name": "Offset", - "description": "Indicates that results should be sorted in order of appearance in the text.", - "value": "Offset" - }, - { - "name": "Rank", - "description": "Indicates that results should be sorted in order of importance (i.e. rank score) according to the model.", - "value": "Rank" - } - ] - } - }, - "ExtractedSummaryDocumentResult": { - "type": "object", - "properties": { - "sentences": { - "type": "array", - "description": "A ranked list of sentences representing the extracted summary.", - "items": { - "$ref": "#/definitions/ExtractedSummarySentence" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "sentences" - ] - }, - "ExtractedSummarySentence": { - "type": "object", - "required": [ - "text", - "rankScore", - "offset", - "length" - ], - "properties": { - "text": { - "type": "string", - "description": "The extracted sentence text." - }, - "rankScore": { - "type": "number", - "format": "double", - "description": "A double value representing the relevance of the sentence within the summary. Higher values indicate higher importance." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The sentence offset from the start of the document, based on the value of the parameter StringIndexType." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the sentence." - } - } - }, - "KeyPhraseTaskParameters": { - "type": "object", - "description": "Supported parameters for a Key Phrase Extraction task.", - "allOf": [ - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - }, - "KeyPhraseLROTask": { - "type": "object", - "description": "An object representing the task definition for a Key Phrase Extraction task.", - "properties": { - "parameters": { - "$ref": "#/definitions/KeyPhraseTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "KeyPhraseExtraction" - }, - "KeyPhraseTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/KeyPhraseResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "x-ms-discriminator-value": "KeyPhraseExtractionResults" - }, - "KeyPhraseResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/KeyPhrasesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "KeyPhrasesDocumentResult": { - "type": "object", - "properties": { - "keyPhrases": { - "type": "array", - "description": "A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.", - "items": { - "type": "string" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "keyPhrases" - ] - }, - "LanguageDetectionTaskParameters": { - "type": "object", - "description": "Supported parameters for a Language Detection task.", - "allOf": [ - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - }, - "LanguageDetectionTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/LanguageDetectionResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "x-ms-discriminator-value": "LanguageDetectionResults" - }, - "LanguageDetectionResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "$ref": "#/definitions/LanguageDetectionDocumentResult" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "LanguageDetectionDocumentResult": { - "type": "object", - "properties": { - "detectedLanguage": { - "description": "Detected Language.", - "$ref": "#/definitions/DetectedLanguage" - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "detectedLanguage" - ] - }, - "DetectedLanguage": { - "type": "object", - "required": [ - "name", - "iso6391Name", - "confidenceScore" - ], - "properties": { - "name": { - "type": "string", - "description": "Long name of a detected language (e.g. English, French)." - }, - "iso6391Name": { - "type": "string", - "description": "A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr)." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true." - } - } - }, - "AnalyzeTextJobState": { - "allOf": [ - { - "$ref": "#/definitions/JobState" - }, - { - "$ref": "#/definitions/TasksState" - }, - { - "$ref": "#/definitions/AnalyzeTextJobStatistics" - } - ] - }, - "Pagination": { - "properties": { - "nextLink": { - "type": "string" - } - }, - "type": "object" - }, - "JobMetadata": { - "properties": { - "displayName": { - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "type": "string" - }, - "jobId": { - "format": "uuid", - "type": "string" - }, - "lastUpdateDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { - "enum": [ - "notStarted", - "running", - "succeeded", - "partiallySucceeded", - "failed", - "cancelled", - "cancelling" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": false, - "name": "State" - } - } - }, - "required": [ - "jobId", - "lastUpdateDateTime", - "createdDateTime", - "status" - ], - "type": "object" - }, - "JobState": { - "properties": { - "displayName": { - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "type": "string" - }, - "jobId": { - "format": "uuid", - "type": "string" - }, - "lastUpdateDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { - "enum": [ - "notStarted", - "running", - "succeeded", - "partiallySucceeded", - "failed", - "cancelled", - "cancelling" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": false, - "name": "State" - } - }, - "errors": { - "items": { - "$ref": "common.json#/definitions/Error" - }, - "type": "array" - }, - "nextLink": { - "type": "string" - } - }, - "required": [ - "jobId", - "lastUpdateDateTime", - "createdDateTime", - "status" - ] - }, - "JobErrors": { - "properties": { - "errors": { - "items": { - "$ref": "common.json#/definitions/Error" - }, - "type": "array" - } - }, - "type": "object" - }, - "AnalyzeTextJobStatistics": { - "properties": { - "statistics": { - "$ref": "#/definitions/RequestStatistics" - } - }, - "type": "object" - }, - "TasksState": { - "properties": { - "tasks": { - "properties": { - "completed": { - "type": "integer" - }, - "failed": { - "type": "integer" - }, - "inProgress": { - "type": "integer" - }, - "total": { - "type": "integer" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - } - }, - "required": [ - "total", - "completed", - "failed", - "inProgress" - ], - "type": "object" - } - }, - "required": [ - "tasks" - ], - "type": "object" - }, - "TaskState": { - "properties": { - "lastUpdateDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling" - ], - "x-ms-enum": { - "modelAsString": false, - "name": "State" - } - } - }, - "required": [ - "status", - "lastUpdateDateTime" - ], - "type": "object" - }, - "AnalyzeTextLROResult": { - "type": "object", - "discriminator": "kind", - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextLROResultsKind" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskState" - }, - { - "$ref": "#/definitions/TaskIdentifier" - } - ], - "required": [ - "kind" - ] - }, - "EntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityRecognitionLROResults" - }, - "CustomEntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomEntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomEntityRecognitionLROResults" - }, - "CustomSingleClassificationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomSingleClassificationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomSingleClassificationLROResults" - }, - "CustomMultiClassificationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomMultiClassificationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomMultiClassificationLROResults" - }, - "EntityLinkingLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntityLinkingResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityLinkingLROResults" - }, - "PiiEntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/PiiResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "PiiEntityRecognitionLROResults" - }, - "ExtractiveSummarizationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/ExtractiveSummarizationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "ExtractiveSummarizationLROResults" - }, - "HealthcareLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/HealthcareResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "HealthcareLROResults" - }, - "SentimentLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/SentimentResponse" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "SentimentAnalysisLROResults" - }, - "KeyPhraseExtractionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/KeyPhraseResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "KeyPhraseExtractionLROResults" - }, - "DocumentResponse": { - "type": "object", - "properties": {} - }, - "DocumentResult": { - "type": "object", - "required": [ - "id", - "warnings" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique, non-empty document identifier." - }, - "warnings": { - "type": "array", - "description": "Warnings encountered while processing document.", - "items": { - "$ref": "#/definitions/DocumentWarning" - } - }, - "statistics": { - "description": "if showStats=true was specified in the request this field will contain information about the document payload.", - "$ref": "#/definitions/DocumentStatistics" - } - } - }, - "DocumentError": { - "type": "object", - "required": [ - "id", - "error" - ], - "properties": { - "id": { - "type": "string", - "description": "Document Id." - }, - "error": { - "type": "object", - "description": "Document Error.", - "$ref": "common.json#/definitions/Error" - } - } - }, - "DocumentWarning": { - "type": "object", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "LongWordsInDocument", - "DocumentTruncated" - ], - "x-ms-enum": { - "name": "WarningCodeValue", - "modelAsString": true - }, - "description": "Error code." - }, - "message": { - "type": "string", - "description": "Warning message." - }, - "targetRef": { - "type": "string", - "description": "A JSON pointer reference indicating the target object." - } - } - }, - "DocumentStatistics": { - "type": "object", - "required": [ - "charactersCount", - "transactionsCount" - ], - "properties": { - "charactersCount": { - "type": "integer", - "format": "int32", - "description": "Number of text elements recognized in the document." - }, - "transactionsCount": { - "type": "integer", - "format": "int32", - "description": "Number of transactions for the document." - } - }, - "description": "if showStats=true was specified in the request this field will contain information about the document payload." - }, - "RequestStatistics": { - "type": "object", - "required": [ - "documentsCount", - "validDocumentsCount", - "erroneousDocumentsCount", - "transactionsCount" - ], - "properties": { - "documentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of documents submitted in the request." - }, - "validDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." - }, - "erroneousDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." - }, - "transactionsCount": { - "type": "integer", - "format": "int64", - "description": "Number of transactions for the request." - } - }, - "description": "if showStats=true was specified in the request this field will contain information about the request payload." - }, - "MultiLanguageInput": { - "type": "object", - "description": "Contains an input document to be analyzed by the service.", - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "A unique, non-empty document identifier." - }, - "text": { - "type": "string", - "description": "The input text to process." - }, - "language": { - "type": "string", - "description": "(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." - } - } - }, - "LanguageInput": { - "type": "object", - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique, non-empty document identifier." - }, - "text": { - "type": "string" - }, - "countryHint": { - "type": "string" - } - } - } - }, - "parameters": { - "ShowStats": { - "name": "showStats", - "in": "query", - "description": "(Optional) if set to true, response will contain request and document level statistics.", - "type": "boolean", - "required": false, - "x-ms-parameter-location": "method" - }, - "JobId": { - "description": "Job ID", - "format": "uuid", - "in": "path", - "name": "jobId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/common.json b/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/common.json deleted file mode 100644 index 66bf79ca64b5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/common.json +++ /dev/null @@ -1,245 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2022-02-01-preview" - }, - "paths": {}, - "definitions": { - "ErrorResponse": { - "type": "object", - "description": "Error response.", - "additionalProperties": false, - "properties": { - "error": { - "description": "The error object.", - "$ref": "#/definitions/Error" - } - } - }, - "Error": { - "type": "object", - "description": "The error object.", - "additionalProperties": false, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/ErrorCode" - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - }, - "target": { - "type": "string", - "description": "The target of the error." - }, - "details": { - "type": "array", - "description": "An array of details about specific errors that led to this reported error.", - "items": { - "$ref": "#/definitions/Error" - } - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "InnerErrorModel": { - "type": "object", - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", - "additionalProperties": false, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/InnerErrorCode" - }, - "message": { - "type": "string", - "description": "Error message." - }, - "details": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Error details." - }, - "target": { - "type": "string", - "description": "Error target." - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "ErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "ErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidArgument", - "Unauthorized", - "Forbidden", - "NotFound", - "ProjectNotFound", - "OperationNotFound", - "AzureCognitiveSearchNotFound", - "AzureCognitiveSearchIndexNotFound", - "TooManyRequests", - "AzureCognitiveSearchThrottling", - "AzureCognitiveSearchIndexLimitReached", - "InternalServerError", - "ServiceUnavailable" - ] - }, - "InnerErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "InnerErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidParameterValue", - "KnowledgeBaseNotFound", - "AzureCognitiveSearchNotFound", - "AzureCognitiveSearchThrottling", - "ExtractionFailure", - "InvalidRequestBodyFormat", - "EmptyRequest", - "MissingInputDocuments", - "InvalidDocument", - "ModelVersionIncorrect", - "InvalidDocumentBatch", - "UnsupportedLanguageCode", - "InvalidCountryHint" - ] - }, - "Language": { - "type": "string", - "description": "Language of the text records. This is BCP-47 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." - }, - "StringIndexType": { - "type": "string", - "description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.", - "default": "TextElements_v8", - "enum": [ - "TextElements_v8", - "UnicodeCodePoint", - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "TextElements_v8", - "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." - }, - { - "value": "UnicodeCodePoint", - "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." - }, - { - "value": "Utf16CodeUnit", - "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - } - } - }, - "parameters": { - "Endpoint": { - "name": "Endpoint", - "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - "ProjectNameQueryParameter": { - "name": "projectName", - "in": "query", - "required": true, - "type": "string", - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "ProjectNamePathParameter": { - "name": "projectName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 100, - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNameQueryParameter": { - "name": "deploymentName", - "in": "query", - "required": true, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNamePathParameter": { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - }, - "TopParameter": { - "name": "top", - "in": "query", - "description": "The maximum number of resources to return from the collection.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "SkipParameter": { - "name": "skip", - "in": "query", - "description": "An offset into the collection of the first resource to be returned.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "MaxPageSizeParameter": { - "name": "maxpagesize", - "in": "query", - "description": "The maximum number of resources to include in a single response.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json deleted file mode 100644 index 75dffb8dc5a8..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json +++ /dev/null @@ -1,131 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-02-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Extracting Location & US Region", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 2, - "failed": 0, - "inProgress": 0, - "total": 2, - "items": [ - { - "kind": "EntityRecognitionLROResults", - "taskName": "Recognize Entities", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "entities": [ - { - "category": "Event", - "confidenceScore": 0.61, - "length": 4, - "offset": 18, - "text": "trip" - }, - { - "category": "Location", - "confidenceScore": 0.82, - "length": 7, - "offset": 26, - "subcategory": "GPE", - "text": "Seattle" - }, - { - "category": "DateTime", - "confidenceScore": 0.8, - "length": 9, - "offset": 34, - "subcategory": "DateRange", - "text": "last week" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "Location", - "confidenceScore": 0.52, - "length": 3, - "offset": 14, - "subcategory": "GPE", - "text": "NYC" - }, - { - "category": "DateTime", - "confidenceScore": 0.8, - "length": 8, - "offset": 18, - "subcategory": "Date", - "text": "tomorrow" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-04-01" - } - }, - { - "kind": "CustomEntityRecognitionLROResults", - "taskName": "Recognize US Regions", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "entities": [ - { - "category": "USRegion", - "confidenceScore": 0.85, - "length": 17, - "offset": 45, - "text": "Pacific Northwest" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "USRegion", - "confidenceScore": 0.88, - "length": 10, - "offset": 63, - "text": "East Coast" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "projectName": "MyProject", - "deploymentName": "MyDeployment" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json deleted file mode 100644 index 591731d3a115..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-02-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Extracting Location & US Region", - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "I had a wonderful trip to Seattle last week." - }, - { - "id": "2", - "language": "en", - "text": "I'm flying to NYC tomorrow. See you there." - } - ] - }, - "tasks": [ - { - "kind": "EntityRecognition", - "taskName": "Recognize Entities", - "parameters": { - "modelVersion": "latest" - } - }, - { - "kind": "CustomEntityRecognition", - "taskName": "Recognize US Regions", - "parameters": { - "projectName": "MyProject", - "deploymentName": "MyDeployment" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulEntityLinkingRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulEntityLinkingRequest.json deleted file mode 100644 index 2447570bfa8d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulEntityLinkingRequest.json +++ /dev/null @@ -1,128 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-02-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "EntityLinking", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Microsoft was founded by Bill Gates and Paul Allen." - }, - { - "id": "2", - "language": "en", - "text": "Pike place market is my favorite Seattle attraction." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "EntityLinkingResults", - "results": { - "documents": [ - { - "entities": [ - { - "dataSource": "Wikipedia", - "id": "Bill Gates", - "language": "en", - "matches": [ - { - "confidenceScore": 0.52, - "length": 10, - "offset": 25, - "text": "Bill Gates" - } - ], - "name": "Bill Gates", - "url": "https://en.wikipedia.org/wiki/Bill_Gates" - }, - { - "dataSource": "Wikipedia", - "id": "Paul Allen", - "language": "en", - "matches": [ - { - "confidenceScore": 0.54, - "length": 10, - "offset": 40, - "text": "Paul Allen" - } - ], - "name": "Paul Allen", - "url": "https://en.wikipedia.org/wiki/Paul_Allen" - }, - { - "dataSource": "Wikipedia", - "id": "Microsoft", - "language": "en", - "matches": [ - { - "confidenceScore": 0.49, - "length": 9, - "offset": 0, - "text": "Microsoft" - } - ], - "name": "Microsoft", - "url": "https://en.wikipedia.org/wiki/Microsoft" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "dataSource": "Wikipedia", - "id": "Pike Place Market", - "language": "en", - "matches": [ - { - "confidenceScore": 0.86, - "length": 17, - "offset": 0, - "text": "Pike place market" - } - ], - "name": "Pike Place Market", - "url": "https://en.wikipedia.org/wiki/Pike_Place_Market" - }, - { - "dataSource": "Wikipedia", - "id": "Seattle", - "language": "en", - "matches": [ - { - "confidenceScore": 0.27, - "length": 7, - "offset": 33, - "text": "Seattle" - } - ], - "name": "Seattle", - "url": "https://en.wikipedia.org/wiki/Seattle" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-02-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulEntityRecognitionRequest.json deleted file mode 100644 index e10b3bd3578e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulEntityRecognitionRequest.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-02-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "EntityRecognition", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Microsoft was founded by Bill Gates and Paul Allen." - }, - { - "id": "2", - "language": "en", - "text": "Pike place market is my favorite Seattle attraction." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "EntityRecognitionResults", - "results": { - "documents": [ - { - "entities": [ - { - "category": "Organization", - "confidenceScore": 0.84, - "length": 9, - "offset": 0, - "text": "Microsoft" - }, - { - "category": "Person", - "confidenceScore": 0.85, - "length": 10, - "offset": 25, - "text": "Bill Gates" - }, - { - "category": "Person", - "confidenceScore": 0.9, - "length": 10, - "offset": 40, - "text": "Paul Allen" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "Location", - "confidenceScore": 0.55, - "length": 7, - "offset": 33, - "subcategory": "GPE", - "text": "Seattle" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-04-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulKeyPhraseExtractionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulKeyPhraseExtractionRequest.json deleted file mode 100644 index f81fed3bf22c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulKeyPhraseExtractionRequest.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-02-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "KeyPhraseExtraction", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Microsoft was founded by Bill Gates and Paul Allen." - }, - { - "id": "2", - "language": "en", - "text": "Text Analytics is one of the Azure Cognitive Services." - }, - { - "id": "3", - "language": "en", - "text": "My cat might need to see a veterinarian." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "KeyPhraseExtractionResults", - "results": { - "documents": [ - { - "id": "1", - "keyPhrases": [ - "Bill Gates", - "Paul Allen", - "Microsoft" - ], - "warnings": [] - }, - { - "id": "2", - "keyPhrases": [ - "Azure Cognitive Services", - "Text Analytics" - ], - "warnings": [] - }, - { - "id": "3", - "keyPhrases": [ - "cat", - "veterinarian" - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2019-10-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulLanguageDetectionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulLanguageDetectionRequest.json deleted file mode 100644 index 90b6046f3e43..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulLanguageDetectionRequest.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-02-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "LanguageDetection", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "text": "Hello world" - }, - { - "id": "2", - "text": "Bonjour tout le monde" - }, - { - "id": "3", - "text": "Hola mundo" - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "LanguageDetectionResults", - "results": { - "documents": [ - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "en", - "name": "English" - }, - "id": "1", - "warnings": [] - }, - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "fr", - "name": "French" - }, - "id": "2", - "warnings": [] - }, - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "es", - "name": "Spanish" - }, - "id": "3", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-04-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulPiiEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulPiiEntityRecognitionRequest.json deleted file mode 100644 index 689dd02f18b7..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulPiiEntityRecognitionRequest.json +++ /dev/null @@ -1,88 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-02-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "PiiEntityRecognition", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "My SSN is 859-98-0987" - }, - { - "id": "2", - "language": "en", - "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." - }, - { - "id": "3", - "language": "en", - "text": "Is 998.214.865-68 your Brazilian CPF number?" - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "PiiEntityRecognitionResults", - "results": { - "documents": [ - { - "id": "1", - "redactedText": "My SSN is ***********", - "entities": [ - { - "category": "U.S. Social Security Number (SSN)", - "confidenceScore": 0.65, - "length": 11, - "offset": 28, - "text": "859-98-0987" - } - ], - "warnings": [] - }, - { - "id": "2", - "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", - "entities": [ - { - "category": "ABA Routing Number", - "confidenceScore": 0.75, - "length": 9, - "offset": 18, - "text": "111000025" - } - ], - "warnings": [] - }, - { - "id": "3", - "redactedText": "Is ************** your Brazilian CPF number?", - "entities": [ - { - "category": "Brazil CPF Number", - "confidenceScore": 0.85, - "length": 14, - "offset": 3, - "text": "998.214.865-68" - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2019-10-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulSentimentAnalysisRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulSentimentAnalysisRequest.json deleted file mode 100644 index a9d53566cc3c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-02-01-preview/examples/SuccessfulSentimentAnalysisRequest.json +++ /dev/null @@ -1,148 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-02-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "SentimentAnalysis", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "SentimentAnalysisResults", - "results": { - "documents": [ - { - "confidenceScores": { - "negative": 0, - "neutral": 0, - "positive": 1 - }, - "id": "1", - "sentences": [ - { - "targets": [ - { - "confidenceScores": { - "negative": 0, - "positive": 1 - }, - "length": 10, - "offset": 6, - "relations": [ - { - "ref": "#/documents/0/sentences/0/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "atmosphere" - } - ], - "confidenceScores": { - "negative": 0, - "neutral": 0, - "positive": 1 - }, - "length": 17, - "offset": 0, - "assessments": [ - { - "confidenceScores": { - "negative": 0, - "positive": 1 - }, - "isNegated": false, - "length": 5, - "offset": 0, - "sentiment": "positive", - "text": "great" - } - ], - "sentiment": "positive", - "text": "Great atmosphere." - }, - { - "targets": [ - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "length": 11, - "offset": 37, - "relations": [ - { - "ref": "#/documents/0/sentences/1/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "restaurants" - }, - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "length": 6, - "offset": 50, - "relations": [ - { - "ref": "#/documents/0/sentences/1/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "hotels" - } - ], - "confidenceScores": { - "negative": 0.01, - "neutral": 0.86, - "positive": 0.13 - }, - "length": 52, - "offset": 18, - "assessments": [ - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "isNegated": false, - "length": 15, - "offset": 18, - "sentiment": "positive", - "text": "Close to plenty" - } - ], - "sentiment": "neutral", - "text": "Close to plenty of restaurants, hotels, and transit!" - } - ], - "sentiment": "positive", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-04-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/analyzeconversations.json b/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/analyzeconversations.json deleted file mode 100644 index 66ef3ccfa0c6..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/analyzeconversations.json +++ /dev/null @@ -1,1430 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Analyze Conversations", - "description": "This API accepts a request and mediates among multiple language projects, such as LUIS Generally Available, Question Answering, Conversational Language Understanding, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload.\n\n In some cases, this API needs to forward requests and responses between the caller and an upstream service.", - "version": "2022-03-01-preview" - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/:analyze-conversations": { - "post": { - "operationId": "ConversationAnalysis_AnalyzeConversation", - "description": "Analyzes the input conversation utterance.", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "A single conversational task to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeConversationTask" - }, - "required": true - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The conversation analysis response.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationTaskResult" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" - } - } - } - }, - "x-ms-examples": { - "Arbitration result": { - "$ref": "./examples/conversations/Orchestrator_arbitration.json" - }, - "Conversation project result": { - "$ref": "./examples/conversations/Conversation_project.json" - }, - "Orchestrator direct target result": { - "$ref": "./examples/conversations/Orchestrator_direct_target.json" - } - } - } - } - }, - "definitions": { - "AnalyzeConversationTaskKind": { - "type": "string", - "description": "Enumeration of supported Conversation tasks.", - "enum": [ - "CustomConversation" - ], - "x-ms-enum": { - "name": "AnalyzeConversationTaskKind", - "modelAsString": true - } - }, - "AnalyzeConversationTaskResultsKind": { - "type": "string", - "description": "Enumeration of supported conversational task results", - "enum": [ - "CustomConversationResult" - ], - "x-ms-enum": { - "name": "AnalyzeConversationTaskResultsKind", - "modelAsString": true - } - }, - "AnalyzeConversationTask": { - "description": "The base class of a conversation input task.", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationTaskKind" - } - } - }, - "AnalyzeConversationTaskResult": { - "description": "The base class of a conversation task result.", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationTaskResultsKind" - } - } - }, - "CustomConversationalTask": { - "description": "The input for a custom conversation task.", - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationTask" - } - ], - "properties": { - "analysisInput": { - "$ref": "#/definitions/ConversationAnalysisOptions" - }, - "parameters": { - "$ref": "#/definitions/CustomConversationTaskParameters" - } - }, - "x-ms-discriminator-value": "CustomConversation", - "required": [ - "analysisInput", - "parameters" - ] - }, - "CustomConversationTaskParameters": { - "type": "object", - "description": "Input parameters necessary for a CustomConversation task.", - "properties": { - "projectName": { - "type": "string", - "description": "The name of the project to use." - }, - "deploymentName": { - "type": "string", - "description": "The name of the deployment to use." - }, - "verbose": { - "type": "boolean", - "description": "If true, the service will return more detailed information in the response." - }, - "isLoggingEnabled": { - "type": "boolean", - "description": "If true, the service will keep the query for further review." - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - }, - "directTarget": { - "type": "string", - "description": "The name of a target project to forward the request to." - }, - "targetProjectParameters": { - "type": "object", - "description": "A dictionary representing the parameters for each target project.", - "additionalProperties": { - "$ref": "#/definitions/AnalysisParameters" - } - } - }, - "required": [ - "projectName", - "deploymentName" - ] - }, - "CustomConversationalTaskResult": { - "description": "The results of a CustomConversation task.", - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationTaskResult" - } - ], - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/AnalyzeConversationResult" - } - }, - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomConversationResult" - }, - "ConversationItemBase": { - "type": "object", - "discriminator": "modality", - "description": "The abstract base for a user input formatted conversation (e.g., Text, Transcript).", - "properties": { - "participantId": { - "description": "The participant Id of a ConversationItem", - "type": "string" - }, - "id": { - "description": "The Id of a ConversationItem", - "type": "string" - }, - "language": { - "description": "The input language of a ConversationItem in BCP 47 language representation.", - "type": "string" - }, - "modality": { - "description": "The modality (format) of ConversationItem (e.g., Text, Transcript)", - "type": "string", - "enum": [ - "text" - ], - "x-ms-enum": { - "name": "modality", - "modelAsString": true - } - } - }, - "required": [ - "participantId", - "id", - "modality" - ] - }, - "TextConversationItem": { - "description": "The text modality of an input conversation.", - "x-ms-discriminator-value": "text", - "allOf": [ - { - "$ref": "#/definitions/ConversationItemBase" - } - ], - "properties": { - "text": { - "description": "The single input query", - "type": "string" - } - }, - "required": [ - "text" - ] - }, - "ConversationAnalysisOptions": { - "type": "object", - "description": "The input ConversationItem and its optional parameters", - "required": [ - "conversationItem" - ], - "properties": { - "conversationItem": { - "$ref": "#/definitions/ConversationItemBase" - } - } - }, - "AnalysisParameters": { - "type": "object", - "description": "This is the parameter set of either the Orchestration project itself or one of the target services.", - "required": [ - "targetKind" - ], - "discriminator": "targetKind", - "properties": { - "targetKind": { - "type": "string", - "description": "The type of a target service.", - "enum": [ - "luis", - "conversation", - "question_answering", - "non_linked" - ], - "x-ms-enum": { - "name": "targetKind", - "modelAsString": true - } - }, - "apiVersion": { - "type": "string", - "description": "The API version to use when call a specific target service." - } - } - }, - "NoneLinkedTargetIntentResult": { - "type": "object", - "description": "A wrap up of non-linked intent response.", - "x-ms-discriminator-value": "non_linked", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "$ref": "#/definitions/ConversationResult", - "description": "The actual response from a Conversation project." - } - } - }, - "LUISParameters": { - "description": "This is a set of request parameters for LUIS Generally Available projects.", - "x-ms-discriminator-value": "luis", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "query": { - "type": "string", - "maxLength": 500, - "description": "The utterance to predict." - }, - "callingOptions": { - "type": "object", - "description": "This customizes how the service calls LUIS Generally Available projects.", - "$ref": "#/definitions/LUISCallingOptions" - } - }, - "additionalProperties": true - }, - "LUISCallingOptions": { - "description": "This customizes how the service calls LUIS Generally Available projects.", - "type": "object", - "properties": { - "verbose": { - "description": "Enable verbose response.", - "type": "boolean" - }, - "log": { - "description": "Save log to add in training utterances later.", - "type": "boolean" - }, - "show-all-intents": { - "description": "Set true to show all intents.", - "type": "boolean" - }, - "timezoneOffset": { - "type": "number", - "description": "The timezone offset for the location of the request." - }, - "spellCheck": { - "type": "boolean", - "description": "Enable spell checking." - }, - "bing-spell-check-subscription-key": { - "description": "The subscription key to use when enabling Bing spell check", - "type": "string" - } - } - }, - "ConversationParameters": { - "type": "object", - "description": "This is a set of request parameters for Customized Conversation projects.", - "x-ms-discriminator-value": "conversation", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "callingOptions": { - "type": "object", - "$ref": "#/definitions/ConversationCallingOptions" - } - } - }, - "ConversationCallingOptions": { - "type": "object", - "description": "The option to set to call a Conversation project.", - "properties": { - "language": { - "description": "The language of the query in BCP 47 language representation..", - "type": "string" - }, - "verbose": { - "description": "If true, the service will return more detailed information.", - "type": "boolean" - }, - "isLoggingEnabled": { - "description": "If true, the query will be saved for customers to further review in authoring, to improve the model quality.", - "type": "boolean" - } - } - }, - "QuestionAnsweringParameters": { - "type": "object", - "description": "This is a set of request parameters for Question Answering knowledge bases.", - "x-ms-discriminator-value": "question_answering", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "callingOptions": { - "type": "object", - "description": "The options sent to a Question Answering KB." - } - } - }, - "AnalyzeConversationResult": { - "type": "object", - "description": "Represents a conversation analysis response.", - "required": [ - "query", - "prediction" - ], - "properties": { - "query": { - "type": "string", - "description": "The conversation utterance given by the caller." - }, - "detectedLanguage": { - "type": "string", - "description": "The system detected language for the query in BCP 47 language representation.." - }, - "prediction": { - "description": "The prediction result of a conversation project.", - "$ref": "#/definitions/BasePrediction" - } - } - }, - "BasePrediction": { - "type": "object", - "description": "This is the base class of prediction", - "required": [ - "projectKind" - ], - "discriminator": "projectKind", - "properties": { - "projectKind": { - "type": "string", - "description": "The type of the project.", - "enum": [ - "conversation", - "workflow" - ], - "x-ms-enum": { - "name": "projectKind", - "modelAsString": true - } - }, - "topIntent": { - "type": "string", - "description": "The intent with the highest score." - } - } - }, - "OrchestratorPrediction": { - "type": "object", - "description": "This represents the prediction result of an Orchestrator project.", - "x-ms-discriminator-value": "workflow", - "required": [ - "intents" - ], - "allOf": [ - { - "$ref": "#/definitions/BasePrediction" - } - ], - "properties": { - "intents": { - "description": "A dictionary that contains all intents. A key is an intent name and a value is its confidence score and target type. The top intent's value also contains the actual response from the target project.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TargetIntentResult" - } - } - } - }, - "TargetIntentResult": { - "type": "object", - "description": "This is the base class of an intent prediction", - "discriminator": "targetKind", - "required": [ - "confidenceScore", - "targetKind" - ], - "properties": { - "targetKind": { - "type": "string", - "description": "This discriminator property specifies the type of the target project that returns the response.", - "enum": [ - "luis", - "conversation", - "question_answering", - "non_linked" - ], - "x-ms-enum": { - "name": "targetKind", - "modelAsString": true - } - }, - "apiVersion": { - "type": "string", - "description": "The API version used to call a target service." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidence", - "description": "The prediction score and it ranges from 0.0 to 1.0.", - "minimum": 0, - "maximum": 1 - } - } - }, - "ConversationTargetIntentResult": { - "type": "object", - "description": "A wrap up of Conversation project response.", - "x-ms-discriminator-value": "conversation", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "type": "object", - "$ref": "#/definitions/ConversationResult", - "description": "The actual response from a Conversation project." - } - } - }, - "ConversationResult": { - "type": "object", - "description": "The response returned by a Conversation project.", - "required": [ - "query", - "prediction" - ], - "properties": { - "query": { - "description": "The same query given in request.", - "type": "string" - }, - "detectedLanguage": { - "description": "The detected language from the query in BCP 47 language representation..", - "type": "string" - }, - "prediction": { - "description": "The predicted result for the query.", - "$ref": "#/definitions/ConversationPrediction" - } - } - }, - "ConversationPrediction": { - "type": "object", - "description": "Represents the prediction section of a Conversation project.", - "x-ms-discriminator-value": "conversation", - "required": [ - "intents", - "entities" - ], - "allOf": [ - { - "$ref": "#/definitions/BasePrediction" - } - ], - "properties": { - "intents": { - "description": "The intent classification results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationIntent" - } - }, - "entities": { - "description": "The entity extraction results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationEntity" - } - } - } - }, - "ConversationIntent": { - "type": "object", - "description": "The intent classification result of a Conversation project.", - "required": [ - "category", - "confidenceScore" - ], - "properties": { - "category": { - "description": "A predicted class.", - "type": "string" - }, - "confidenceScore": { - "format": "float", - "x-ms-client-name": "confidence", - "description": "The confidence score of the class from 0.0 to 1.0.", - "type": "number", - "minimum": 0, - "maximum": 1 - } - } - }, - "ConversationEntity": { - "type": "object", - "description": "The entity extraction result of a Conversation project.", - "required": [ - "category", - "text", - "offset", - "length", - "confidenceScore" - ], - "properties": { - "category": { - "description": "The entity category.", - "type": "string" - }, - "text": { - "description": "The predicted entity text.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "The starting index of this entity in the query.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "The length of the text.", - "type": "integer" - }, - "confidenceScore": { - "format": "float", - "x-ms-client-name": "confidence", - "description": "The entity confidence score.", - "type": "number" - }, - "resolutions": { - "description": "The collection of entity resolution objects.", - "type": "array", - "items": { - "$ref": "#/definitions/BaseResolution" - } - }, - "extraInformation": { - "description": "The collection of entity extra information objects.", - "type": "array", - "items": { - "$ref": "#/definitions/BaseExtraInformation" - } - } - } - }, - "BaseExtraInformation": { - "description": "The abstract base object for entity extra information.", - "type": "object", - "discriminator": "extraInformationKind", - "properties": { - "extraInformationKind": { - "description": "The extra information object kind.", - "type": "string", - "enum": [ - "EntitySubtype", - "ListKey" - ], - "x-ms-enum": { - "name": "ExtraInformationKind", - "modelAsString": true - } - } - }, - "required": [ - "extraInformationKind" - ] - }, - "EntitySubtype": { - "description": "The concrete entity Subtype model of extra information.", - "allOf": [ - { - "$ref": "#/definitions/BaseExtraInformation" - } - ], - "type": "object", - "x-ms-discriminator-value": "EntitySubtype", - "properties": { - "value": { - "type": "string", - "description": "The Subtype of an extracted entity type." - } - } - }, - "ListKey": { - "description": "The list key extra data kind.", - "allOf": [ - { - "$ref": "#/definitions/BaseExtraInformation" - } - ], - "type": "object", - "x-ms-discriminator-value": "ListKey", - "properties": { - "key": { - "type": "string", - "description": "The canonical form of the extracted entity." - } - } - }, - "BaseResolution": { - "description": "The abstract base class for entity resolutions.", - "type": "object", - "discriminator": "resolutionKind", - "properties": { - "resolutionKind": { - "description": "The entity resolution object kind.", - "type": "string", - "enum": [ - "BooleanResolution", - "DateTimeResolution", - "NumberResolution", - "OrdinalResolution", - "SpeedResolution", - "WeightResolution", - "LengthResolution", - "VolumeResolution", - "AreaResolution", - "AgeResolution", - "InformationResolution", - "TemperatureResolution", - "CurrencyResolution", - "NumericRangeResolution", - "TemporalSpanResolution" - ], - "x-ms-enum": { - "name": "ResolutionKind", - "modelAsString": true - } - } - }, - "required": [ - "resolutionKind" - ] - }, - "QuantityResolution": { - "description": "represents resolutions for quantities.", - "type": "object", - "properties": { - "value": { - "type": "number", - "format": "double", - "description": "The numeric value that the extracted text denotes." - } - }, - "required": [ - "value" - ] - }, - "AgeResolution": { - "description": "Represents the Age entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "AgeResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Year", - "Month", - "Week", - "Day" - ], - "x-ms-enum": { - "name": "AgeUnit", - "modelAsString": true - }, - "description": "The Age Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "VolumeResolution": { - "description": "Represents the volume entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "VolumeResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "CubicMeter", - "CubicCentimeter", - "CubicMillimeter", - "Hectoliter", - "Decaliter", - "Liter", - "Centiliter", - "Milliliter", - "CubicYard", - "CubicInch", - "CubicFoot", - "CubicMile", - "FluidOunce", - "Teaspoon", - "Tablespoon", - "Pint", - "Quart", - "Cup", - "Gill", - "Pinch", - "FluidDram", - "Barrel", - "Minim", - "Cord", - "Peck", - "Bushel", - "Hogshead" - ], - "x-ms-enum": { - "name": "VolumeUnit", - "modelAsString": true - }, - "description": "The Volume Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "SpeedResolution": { - "description": "Represents the speed entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "SpeedResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "MetersPerSecond", - "KilometersPerHour", - "KilometersPerMinute", - "KilometersPerSecond", - "MilesPerHour", - "Knot", - "FootPerSecond", - "FootPerMinute", - "YardsPerMinute", - "YardsPerSecond", - "MetersPerMillisecond", - "CentimetersPerMillisecond", - "KilometersPerMillisecond" - ], - "x-ms-enum": { - "name": "SpeedUnit", - "modelAsString": true - }, - "description": "The speed Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "AreaResolution": { - "description": "Represents the area entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "AreaResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "SquareKilometer", - "SquareHectometer", - "SquareDecameter", - "SquareDecimeter", - "SquareMeter", - "SquareCentimeter", - "SquareMillimeter", - "SquareInch", - "SquareFoot", - "SquareMile", - "SquareYard", - "Acre" - ], - "x-ms-enum": { - "name": "AreaUnit", - "modelAsString": true - }, - "description": "The area Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "LengthResolution": { - "description": "Represents the length entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "LengthResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Kilometer", - "Hectometer", - "Decameter", - "Meter", - "Decimeter", - "Centimeter", - "Millimeter", - "Micrometer", - "Nanometer", - "Picometer", - "Mile", - "Yard", - "Inch", - "Foot", - "LightYear", - "Pt" - ], - "x-ms-enum": { - "name": "LengthUnit", - "modelAsString": true - }, - "description": "The length Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "InformationResolution": { - "description": "Represents the information (data) entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "InformationResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Bit", - "Kilobit", - "Megabit", - "Gigabit", - "Terabit", - "Petabit", - "Byte", - "Kilobyte", - "Megabyte", - "Gigabyte", - "Terabyte", - "Petabyte" - ], - "x-ms-enum": { - "name": "InformationUnit", - "modelAsString": true - }, - "description": "The information (data) Unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "TemperatureResolution": { - "description": "Represents the temperature entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "TemperatureResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Fahrenheit", - "Kelvin", - "Rankine", - "Celsius" - ], - "x-ms-enum": { - "name": "TemperatureUnit", - "modelAsString": true - }, - "description": "The temperature Unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "WeightResolution": { - "description": "Represents the weight entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "WeightResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Kilogram", - "Gram", - "Milligram", - "Gallon", - "MetricTon", - "Ton", - "Pound", - "Ounce", - "Grain", - "PennyWeight", - "LongTonBritish", - "ShortTonUS", - "ShortHundredWeightUS", - "Stone", - "Dram" - ], - "x-ms-enum": { - "name": "WeightUnit", - "modelAsString": true - }, - "description": "The weight Unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "CurrencyResolution": { - "description": "Represents the currency entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "CurrencyResolution", - "properties": { - "ISO4217": { - "type": "string", - "description": "The alphabetic code based on another ISO standard, ISO 3166, which lists the codes for country names. The first two letters of the ISO 4217 three-letter code are the same as the code for the country name, and, where possible, the third letter corresponds to the first letter of the currency name." - }, - "value": { - "type": "number", - "format": "double", - "description": "The money amount captured in the extracted entity" - }, - "unit": { - "type": "string", - "description": "The unit of the amount captured in the extracted entity" - } - }, - "required": [ - "value", - "unit" - ] - }, - "BooleanResolution": { - "description": "A resolution for boolean expressions", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "BooleanResolution", - "properties": { - "value": { - "type": "boolean" - } - }, - "required": [ - "value" - ] - }, - "DateTimeResolution": { - "description": "A resolution for datetime entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "DateTimeResolution", - "properties": { - "timex": { - "$ref": "#/definitions/TimeExpression" - }, - "dateTimeSubKind": { - "type": "string", - "enum": [ - "Time", - "Date", - "DateTime", - "Duration", - "Set" - ], - "x-ms-enum": { - "name": "DateTimeSubKind", - "modelAsString": true - }, - "description": "The DateTime SubKind" - }, - "value": { - "type": "string", - "description": "The actual time that the extracted text denote." - }, - "modifier": { - "$ref": "#/definitions/TemporalModifier" - } - }, - "required": [ - "timex", - "dateTimeSubKind", - "value" - ] - }, - "NumberResolution": { - "description": "A resolution for numeric entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "NumberResolution", - "properties": { - "numberKind": { - "type": "string", - "enum": [ - "Integer", - "Decimal", - "Power", - "Fraction", - "Percent", - "Unspecified" - ], - "x-ms-enum": { - "name": "NumberKind", - "modelAsString": true - }, - "description": "The type of the extracted number entity." - }, - "value": { - "type": "string", - "description": "A numeric representation of what the extracted text denotes." - } - }, - "required": [ - "numberKind", - "value" - ] - }, - "OrdinalResolution": { - "description": "A resolution for ordinal numbers entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "OrdinalResolution", - "properties": { - "offset": { - "type": "string", - "description": "The offset With respect to the reference (e.g., offset = -1 in \"show me the second to last\"" - }, - "relativeTo": { - "type": "string", - "enum": [ - "Current", - "End", - "Start" - ], - "x-ms-enum": { - "name": "RelativeTo", - "modelAsString": true - }, - "description": "The reference point that the ordinal number denotes." - }, - "value": { - "type": "string", - "description": "A simple arithmetic expression that the ordinal denotes." - } - }, - "required": [ - "offset", - "relativeTo", - "value" - ] - }, - "TemporalSpanResolution": { - "description": "represents the resolution of a date and/or time span.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "TemporalSpanResolution", - "properties": { - "begin": { - "$ref": "#/definitions/TimeExpression" - }, - "end": { - "$ref": "#/definitions/TimeExpression" - }, - "duration": { - "type": "string", - "description": "An optional duration value formatted based on the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)" - }, - "modifier": { - "$ref": "#/definitions/TemporalModifier" - } - } - }, - "NumericRangeResolution": { - "description": "represents the resolution of numeric intervals.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "NumericRangeResolution", - "properties": { - "rangeKind": { - "type": "string", - "enum": [ - "Number", - "Speed", - "Weight", - "Length", - "Volume", - "Area", - "Age", - "Information", - "Temperature", - "Currency" - ], - "x-ms-enum": { - "name": "RangeKind", - "modelAsString": true - }, - "description": "The kind of range that the resolution object represents." - }, - "minimum": { - "type": "number", - "format": "double", - "description": "The beginning value of the interval." - }, - "maximum": { - "type": "number", - "format": "double", - "description": "The ending value of the interval." - } - }, - "required": [ - "rangeKind", - "minimum", - "maximum" - ] - }, - "TemporalModifier": { - "type": "string", - "description": "An optional modifier of a date/time instance.", - "enum": [ - "AfterApprox", - "Before", - "BeforeStart", - "Approx", - "ReferenceUndefined", - "SinceEnd", - "AfterMid", - "Start", - "After", - "BeforeEnd", - "Until", - "End", - "Less", - "Since", - "AfterStart", - "BeforeApprox", - "Mid", - "More" - ], - "x-ms-enum": { - "name": "Modifier", - "modelAsString": true - } - }, - "TimeExpression": { - "type": "string", - "description": "An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)" - }, - "LUISTargetIntentResult": { - "type": "object", - "description": "It is a wrap up of LUIS Generally Available response.", - "x-ms-discriminator-value": "luis", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "type": "object", - "description": "The actual response from a LUIS Generally Available application." - } - } - }, - "QuestionAnsweringTargetIntentResult": { - "type": "object", - "description": "It is a wrap up a Question Answering KB response.", - "x-ms-discriminator-value": "question_answering", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "type": "object", - "$ref": "../2021-07-15-preview/questionanswering.json#/definitions/KnowledgeBaseAnswers", - "description": "The generated answer by a Question Answering KB." - } - } - } - }, - "parameters": { - "ConversationAnalysisOptions": { - "name": "ConversationAnalysisOptions", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationAnalysisOptions" - }, - "description": "Post body of the request.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/analyzetext.json b/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/analyzetext.json deleted file mode 100644 index 48744ccd8945..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/analyzetext.json +++ /dev/null @@ -1,2903 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Text Analysis", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview.0", - "version": "2022-03-01-preview" - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/:analyze-text": { - "post": { - "summary": "Request text analysis over a collection of documents.", - "description": "Submit a collection of text documents for analysis. Specify a single unique task to be executed immediately.", - "operationId": "AnalyzeText", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ShowStats" - }, - { - "description": "Collection of documents to analyze and a single task to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeTextTask" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "A successful call result", - "schema": { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Entity Linking Request": { - "$ref": "./examples/SuccessfulEntityLinkingRequest.json" - }, - "Successful Entity Recognition Request": { - "$ref": "./examples/SuccessfulEntityRecognitionRequest.json" - }, - "Successful Key Phrase Extraction Request": { - "$ref": "./examples/SuccessfulKeyPhraseExtractionRequest.json" - }, - "Successful PII Entity Recognition Request": { - "$ref": "./examples/SuccessfulPiiEntityRecognitionRequest.json" - }, - "Successful Language Detection Request": { - "$ref": "./examples/SuccessfulLanguageDetectionRequest.json" - }, - "Successful Sentiment Analysis Request": { - "$ref": "./examples/SuccessfulSentimentAnalysisRequest.json" - } - } - } - }, - "/analyze-text/jobs": { - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "description": "Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.", - "operationId": "AnalyzeText_SubmitJob", - "summary": "Submit text analysis job", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Collection of documents to analyze and one or more tasks to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeTextJobsInput" - }, - "required": true - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Submit Analysis Job Request": { - "$ref": "./examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/analyze-text/jobs/{jobId}": { - "get": { - "produces": [ - "application/json" - ], - "description": "Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are succeeded, the job will transition to the succeeded state and results will be available for each task.", - "operationId": "AnalyzeText_JobStatus", - "summary": "Get analysis status and results", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobId" - }, - { - "$ref": "#/parameters/ShowStats" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - } - ], - "responses": { - "200": { - "description": "Analysis job status and metadata.", - "schema": { - "$ref": "#/definitions/AnalyzeTextJobState" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Text Analysis Job Status Request": { - "$ref": "./examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json" - } - } - } - }, - "/analyze-text/jobs/{jobId}:cancel": { - "post": { - "produces": [ - "application/json" - ], - "description": "Cancel a long-running Text Analysis job.", - "operationId": "AnalyzeText_CancelJob", - "summary": "Cancel a long-running Text Analysis job", - "parameters": [ - { - "$ref": "#/parameters/JobId" - } - ], - "responses": { - "202": { - "description": "Cancel Job request has been received.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Job Delete Request": { - "$ref": ".//examples//SuccessfulAnalyzeTextJobsCancelRequest.json" - } - }, - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "AnalyzeTextTaskKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis tasks.", - "enum": [ - "SentimentAnalysis", - "EntityRecognition", - "PiiEntityRecognition", - "KeyPhraseExtraction", - "LanguageDetection", - "EntityLinking" - ], - "x-ms-enum": { - "name": "AnalyzeTextTaskKind", - "modelAsString": true - } - }, - "AnalyzeTextLROTaskKind": { - "type": "string", - "description": "Enumeration of supported long-running Text Analysis tasks.", - "enum": [ - "SentimentAnalysis", - "EntityRecognition", - "PiiEntityRecognition", - "KeyPhraseExtraction", - "EntityLinking", - "Healthcare", - "ExtractiveSummarization", - "CustomEntityRecognition", - "CustomSingleLabelClassification", - "CustomMultiLabelClassification" - ], - "x-ms-enum": { - "name": "AnalyzeTextLROTaskKind", - "modelAsString": true - } - }, - "AnalyzeTextTaskResultsKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis task results.", - "enum": [ - "SentimentAnalysisResults", - "EntityRecognitionResults", - "PiiEntityRecognitionResults", - "KeyPhraseExtractionResults", - "LanguageDetectionResults", - "EntityLinkingResults" - ], - "x-ms-enum": { - "name": "AnalyzeTextTaskResultsKind", - "modelAsString": true - } - }, - "AnalyzeTextLROResultsKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis long-running operation task results.", - "enum": [ - "SentimentAnalysisLROResults", - "EntityRecognitionLROResults", - "PiiEntityRecognitionLROResults", - "KeyPhraseExtractionLROResults", - "EntityLinkingLROResults", - "HealthcareLROResults", - "ExtractiveSummarizationLROResults", - "CustomEntityRecognitionLROResults", - "CustomSingleLabelClassificationLROResults", - "CustomMultiLabelClassificationLROResults" - ], - "x-ms-enum": { - "name": "AnalyzeTextLROResultsKind", - "modelAsString": true - } - }, - "MultiLanguageAnalysisInput": { - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/definitions/MultiLanguageInput" - } - } - } - }, - "LanguageDetectionAnalysisInput": { - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/definitions/LanguageInput" - } - } - } - }, - "AnalyzeTextTask": { - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextTaskKind" - } - } - }, - "AnalyzeTextLROTask": { - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextLROTaskKind" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskIdentifier" - } - ] - }, - "AnalyzeTextTaskResult": { - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextTaskResultsKind" - } - } - }, - "AnalyzeTextEntityLinkingInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/EntityLinkingTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "EntityLinking" - }, - "AnalyzeTextEntityRecognitionInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/EntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "EntityRecognition" - }, - "AnalyzeTextKeyPhraseExtractionInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/KeyPhraseTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "KeyPhraseExtraction" - }, - "AnalyzeTextPiiEntitiesRecognitionInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/PiiTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "PiiEntityRecognition" - }, - "AnalyzeTextLanguageDetectionInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/LanguageDetectionAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/LanguageDetectionTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "LanguageDetection" - }, - "AnalyzeTextSentimentAnalysisInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/SentimentAnalysisTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "SentimentAnalysis" - }, - "AnalyzeTextJobsInput": { - "properties": { - "displayName": { - "description": "Optional display name for the analysis job.", - "type": "string" - }, - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "tasks": { - "description": "The set of tasks to execute on the input documents.", - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - } - }, - "required": [ - "analysisInput", - "tasks" - ] - }, - "TaskIdentifier": { - "type": "object", - "description": "Base task object.", - "properties": { - "taskName": { - "type": "string" - } - } - }, - "TaskParameters": { - "type": "object", - "description": "Base parameters object for a text analysis task.", - "properties": { - "loggingOptOut": { - "type": "boolean", - "default": false - } - } - }, - "PreBuiltTaskParameters": { - "type": "object", - "description": "Parameters object for a text analysis task using pre-built models.", - "properties": { - "modelVersion": { - "type": "string", - "default": "latest" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - } - ] - }, - "PreBuiltResult": { - "properties": { - "errors": { - "type": "array", - "description": "Errors by document id.", - "items": { - "$ref": "#/definitions/DocumentError" - } - }, - "statistics": { - "$ref": "#/definitions/RequestStatistics" - }, - "modelVersion": { - "type": "string", - "description": "This field indicates which model is used for scoring." - } - }, - "required": [ - "errors", - "modelVersion" - ] - }, - "CustomTaskParameters": { - "type": "object", - "description": "Parameters object for a text analysis task using custom models.", - "properties": { - "projectName": { - "type": "string" - }, - "deploymentName": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - } - ], - "required": [ - "projectName", - "deploymentName" - ] - }, - "CustomResult": { - "properties": { - "errors": { - "type": "array", - "description": "Errors by document id.", - "items": { - "$ref": "#/definitions/DocumentError" - } - }, - "statistics": { - "$ref": "#/definitions/RequestStatistics" - }, - "projectName": { - "type": "string", - "description": "This field indicates the project name for the model." - }, - "deploymentName": { - "type": "string", - "description": "This field indicates the deployment name for the model." - } - }, - "required": [ - "errors", - "projectName", - "deploymentName" - ] - }, - "CustomEntitiesTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Entities task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/CustomTaskParameters" - } - ] - }, - "CustomEntitiesLROTask": { - "type": "object", - "description": "Use custom models to ease the process of information extraction from unstructured documents like contracts or financial documents", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomEntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomEntityRecognition" - }, - "CustomEntitiesResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/EntitiesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/CustomResult" - } - ], - "required": [ - "documents" - ] - }, - "CustomSingleLabelClassificationTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Single Classification task.", - "allOf": [ - { - "$ref": "#/definitions/CustomTaskParameters" - } - ] - }, - "CustomSingleLabelClassificationLROTask": { - "type": "object", - "description": "Use custom models to classify text into single label taxonomy", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomSingleLabelClassificationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomSingleLabelClassification" - }, - "CustomSingleLabelClassificationResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/SingleClassificationDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/CustomResult" - } - ], - "required": [ - "documents" - ] - }, - "SingleClassificationDocumentResult": { - "type": "object", - "properties": { - "class": { - "$ref": "#/definitions/ClassificationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "class" - ] - }, - "ClassificationResult": { - "type": "object", - "required": [ - "category", - "confidenceScore" - ], - "properties": { - "category": { - "type": "string", - "description": "Classification type." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the recognized class." - } - } - }, - "CustomMultiLabelClassificationTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Multi Classification task.", - "allOf": [ - { - "$ref": "#/definitions/CustomTaskParameters" - } - ] - }, - "CustomMultiLabelClassificationLROTask": { - "type": "object", - "description": "Use custom models to classify text into multi label taxonomy", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomMultiLabelClassificationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomMultiLabelClassification" - }, - "CustomMultiLabelClassificationResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/MultiClassificationDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/CustomResult" - } - ], - "required": [ - "documents" - ] - }, - "MultiClassificationDocumentResult": { - "type": "object", - "properties": { - "class": { - "type": "array", - "items": { - "$ref": "#/definitions/ClassificationResult" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "class" - ] - }, - "HealthcareTaskParameters": { - "type": "object", - "description": "Supported parameters for a Healthcare task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - }, - "HealthcareLROTask": { - "type": "object", - "properties": { - "parameters": { - "$ref": "#/definitions/HealthcareTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "Healthcare" - }, - "HealthcareResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "#/definitions/HealthcareEntitiesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "HealthcareEntitiesDocumentResult": { - "type": "object", - "properties": { - "entities": { - "description": "Healthcare entities.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareEntity" - } - }, - "relations": { - "type": "array", - "description": "Healthcare entity relations.", - "items": { - "$ref": "#/definitions/HealthcareRelation" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "entities", - "relations" - ] - }, - "HealthcareEntity": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "x-ms-enum": { - "name": "healthcareEntityCategory", - "modelAsString": true - }, - "type": "string", - "description": "Healthcare Entity Category.", - "enum": [ - "BODY_STRUCTURE", - "AGE", - "GENDER", - "EXAMINATION_NAME", - "DATE", - "DIRECTION", - "FREQUENCY", - "MEASUREMENT_VALUE", - "MEASUREMENT_UNIT", - "RELATIONAL_OPERATOR", - "TIME", - "GENE_OR_PROTEIN", - "VARIANT", - "ADMINISTRATIVE_EVENT", - "CARE_ENVIRONMENT", - "HEALTHCARE_PROFESSION", - "DIAGNOSIS", - "SYMPTOM_OR_SIGN", - "CONDITION_QUALIFIER", - "MEDICATION_CLASS", - "MEDICATION_NAME", - "DOSAGE", - "MEDICATION_FORM", - "MEDICATION_ROUTE", - "FAMILY_RELATION", - "TREATMENT_NAME" - ] - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub type." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted entity." - }, - "assertion": { - "type": "object", - "$ref": "#/definitions/HealthcareAssertion" - }, - "name": { - "description": "Preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'.", - "type": "string" - }, - "links": { - "description": "Entity references in known data sources.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareEntityLink" - } - } - }, - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ] - }, - "HealthcareRelation": { - "type": "object", - "description": "Every relation is an entity graph of a certain relationType, where all entities are connected and have specific roles within the relation context.", - "required": [ - "relationType", - "entities" - ], - "properties": { - "relationType": { - "description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc.", - "type": "string", - "enum": [ - "Abbreviation", - "DirectionOfBodyStructure", - "DirectionOfCondition", - "DirectionOfExamination", - "DirectionOfTreatment", - "DosageOfMedication", - "FormOfMedication", - "FrequencyOfMedication", - "FrequencyOfTreatment", - "QualifierOfCondition", - "RelationOfExamination", - "RouteOfMedication", - "TimeOfCondition", - "TimeOfEvent", - "TimeOfExamination", - "TimeOfMedication", - "TimeOfTreatment", - "UnitOfCondition", - "UnitOfExamination", - "ValueOfCondition", - "ValueOfExamination" - ], - "x-ms-enum": { - "name": "relationType", - "modelAsString": true - } - }, - "entities": { - "description": "The entities in the relation.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareRelationEntity" - } - } - } - }, - "HealthcareAssertion": { - "type": "object", - "properties": { - "conditionality": { - "description": "Describes any conditionality on the entity.", - "type": "string", - "enum": [ - "hypothetical", - "conditional" - ], - "x-ms-enum": { - "name": "Conditionality", - "modelAsString": false - } - }, - "certainty": { - "description": "Describes the entities certainty and polarity.", - "type": "string", - "enum": [ - "positive", - "positivePossible", - "neutralPossible", - "negativePossible", - "negative" - ], - "x-ms-enum": { - "name": "Certainty", - "modelAsString": false - } - }, - "association": { - "description": "Describes if the entity is the subject of the text or if it describes someone else.", - "type": "string", - "enum": [ - "subject", - "other" - ], - "x-ms-enum": { - "name": "Association", - "modelAsString": false - } - } - } - }, - "HealthcareRelationEntity": { - "type": "object", - "required": [ - "ref", - "role" - ], - "properties": { - "ref": { - "description": "Reference link object, using a JSON pointer RFC 6901 (URI Fragment Identifier Representation), pointing to the entity .", - "type": "string" - }, - "role": { - "description": "Role of entity in the relationship. For example: 'CD20-positive diffuse large B-cell lymphoma' has the following entities with their roles in parenthesis: CD20 (GeneOrProtein), Positive (Expression), diffuse large B-cell lymphoma (Diagnosis).", - "type": "string" - } - } - }, - "HealthcareEntityLink": { - "type": "object", - "required": [ - "dataSource", - "id" - ], - "properties": { - "dataSource": { - "description": "Entity Catalog. Examples include: UMLS, CHV, MSH, etc.", - "type": "string" - }, - "id": { - "description": "Entity id in the given source catalog.", - "type": "string" - } - } - }, - "SentimentAnalysisTaskParameters": { - "type": "object", - "description": "Supported parameters for a Sentiment Analysis task.", - "properties": { - "opinionMining": { - "type": "boolean", - "default": false - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - }, - "SentimentAnalysisLROTask": { - "type": "object", - "description": "An object representing the task definition for a Sentiment Analysis task.", - "properties": { - "parameters": { - "$ref": "#/definitions/SentimentAnalysisTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "SentimentAnalysis" - }, - "SentimentTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/SentimentResponse" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "SentimentAnalysisResults" - }, - "SentimentResponse": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Sentiment analysis per document.", - "items": { - "allOf": [ - { - "$ref": "#/definitions/SentimentDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "SentimentDocumentResult": { - "type": "object", - "properties": { - "sentiment": { - "type": "string", - "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).", - "enum": [ - "positive", - "neutral", - "negative", - "mixed" - ], - "x-ms-enum": { - "name": "DocumentSentimentValue", - "modelAsString": false - } - }, - "confidenceScores": { - "description": "Document level sentiment confidence scores between 0 and 1 for each sentiment class.", - "$ref": "#/definitions/SentimentConfidenceScorePerLabel" - }, - "sentences": { - "type": "array", - "description": "Sentence level sentiment analysis.", - "items": { - "$ref": "#/definitions/SentenceSentiment" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "sentiment", - "confidenceScores", - "sentences" - ] - }, - "SentimentConfidenceScorePerLabel": { - "type": "object", - "required": [ - "positive", - "neutral", - "negative" - ], - "properties": { - "positive": { - "type": "number", - "format": "double" - }, - "neutral": { - "type": "number", - "format": "double" - }, - "negative": { - "type": "number", - "format": "double" - } - }, - "description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative." - }, - "SentenceSentiment": { - "type": "object", - "required": [ - "text", - "sentiment", - "confidenceScores", - "offset", - "length" - ], - "properties": { - "text": { - "type": "string", - "description": "The sentence text." - }, - "sentiment": { - "type": "string", - "description": "The predicted Sentiment for the sentence.", - "enum": [ - "positive", - "neutral", - "negative" - ], - "x-ms-enum": { - "name": "SentenceSentimentValue", - "modelAsString": false - } - }, - "confidenceScores": { - "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes.", - "$ref": "#/definitions/SentimentConfidenceScorePerLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The sentence offset from the start of the document." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the sentence." - }, - "targets": { - "type": "array", - "description": "The array of sentence targets for the sentence.", - "items": { - "$ref": "#/definitions/SentenceTarget" - } - }, - "assessments": { - "type": "array", - "description": "The array of assessments for the sentence.", - "items": { - "$ref": "#/definitions/SentenceAssessment" - } - } - } - }, - "SentenceTarget": { - "type": "object", - "required": [ - "confidenceScores", - "length", - "offset", - "relations", - "sentiment", - "text" - ], - "properties": { - "sentiment": { - "type": "string", - "enum": [ - "positive", - "mixed", - "negative" - ], - "x-ms-enum": { - "name": "TokenSentimentValue", - "modelAsString": false - }, - "description": "Targeted sentiment in the sentence." - }, - "confidenceScores": { - "description": "Target sentiment confidence scores for the target in the sentence.", - "$ref": "#/definitions/TargetConfidenceScoreLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The target offset from the start of the sentence." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the target." - }, - "text": { - "type": "string", - "description": "The target text detected." - }, - "relations": { - "type": "array", - "description": "The array of either assessment or target objects which is related to the target.", - "items": { - "$ref": "#/definitions/TargetRelation" - } - } - } - }, - "SentenceAssessment": { - "type": "object", - "required": [ - "confidenceScores", - "isNegated", - "length", - "offset", - "sentiment", - "text" - ], - "properties": { - "sentiment": { - "type": "string", - "enum": [ - "positive", - "mixed", - "negative" - ], - "x-ms-enum": { - "name": "TokenSentimentValue", - "modelAsString": false - }, - "description": "Assessment sentiment in the sentence." - }, - "confidenceScores": { - "description": "Assessment sentiment confidence scores in the sentence.", - "$ref": "#/definitions/TargetConfidenceScoreLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The assessment offset from the start of the sentence." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the assessment." - }, - "text": { - "type": "string", - "description": "The assessment text detected." - }, - "isNegated": { - "type": "boolean", - "description": "The indicator representing if the assessment is negated." - } - } - }, - "TargetRelation": { - "type": "object", - "required": [ - "ref", - "relationType" - ], - "properties": { - "relationType": { - "type": "string", - "enum": [ - "assessment", - "target" - ], - "x-ms-enum": { - "name": "TargetRelationType", - "modelAsString": false - }, - "description": "The type related to the target." - }, - "ref": { - "type": "string", - "description": "The JSON pointer indicating the linked object." - } - } - }, - "TargetConfidenceScoreLabel": { - "type": "object", - "required": [ - "negative", - "positive" - ], - "properties": { - "positive": { - "type": "number", - "format": "double" - }, - "negative": { - "type": "number", - "format": "double" - } - }, - "description": "Represents the confidence scores across all sentiment classes: positive, neutral, negative." - }, - "EntitiesTaskParameters": { - "type": "object", - "description": "Supported parameters for an Entity Recognition task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - }, - "EntitiesLROTask": { - "type": "object", - "description": "An object representing the task definition for an Entities Recognition task.", - "properties": { - "parameters": { - "$ref": "#/definitions/EntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "EntityRecognition" - }, - "EntitiesTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityRecognitionResults" - }, - "EntitiesResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/EntitiesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "EntitiesDocumentResult": { - "type": "object", - "properties": { - "entities": { - "type": "array", - "description": "Recognized entities in the document.", - "items": { - "$ref": "#/definitions/Entity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "entities" - ] - }, - "Entity": { - "type": "object", - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ], - "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "type": "string", - "description": "Entity type." - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub type." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted entity." - } - } - }, - "EntityLinkingTaskParameters": { - "type": "object", - "description": "Supported parameters for an Entity Linking task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - }, - "EntityLinkingLROTask": { - "type": "object", - "description": "An object representing the task definition for an Entity Linking task.", - "properties": { - "parameters": { - "$ref": "#/definitions/EntityLinkingTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "EntityLinking" - }, - "EntityLinkingTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntityLinkingResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityLinkingResults" - }, - "EntityLinkingResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/LinkedEntitiesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "LinkedEntitiesDocumentResult": { - "type": "object", - "required": [ - "entities" - ], - "properties": { - "entities": { - "type": "array", - "description": "Recognized well known entities in the document.", - "items": { - "$ref": "#/definitions/LinkedEntity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ] - }, - "LinkedEntity": { - "type": "object", - "required": [ - "name", - "matches", - "language", - "url", - "dataSource" - ], - "properties": { - "name": { - "type": "string", - "description": "Entity Linking formal name." - }, - "matches": { - "type": "array", - "description": "List of instances this entity appears in the text.", - "items": { - "$ref": "#/definitions/Match" - } - }, - "language": { - "type": "string", - "description": "Language used in the data source." - }, - "id": { - "type": "string", - "description": "Unique identifier of the recognized entity from the data source." - }, - "url": { - "type": "string", - "description": "URL for the entity's page from the data source." - }, - "dataSource": { - "type": "string", - "description": "Data source used to extract entity linking, such as Wiki/Bing etc." - }, - "bingId": { - "type": "string", - "description": "Bing Entity Search API unique identifier of the recognized entity." - } - } - }, - "Match": { - "type": "object", - "required": [ - "confidenceScore", - "text", - "offset", - "length" - ], - "properties": { - "confidenceScore": { - "type": "number", - "format": "double", - "description": "If a well known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned." - }, - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity match text." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity match text." - } - } - }, - "PiiTaskParameters": { - "type": "object", - "description": "Supported parameters for a PII Entities Recognition task.", - "properties": { - "domain": { - "$ref": "#/definitions/PiiDomain" - }, - "piiCategories": { - "$ref": "#/definitions/PiiCategories" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - }, - "PiiLROTask": { - "type": "object", - "description": "An object representing the task definition for a PII Entities Recognition task.", - "properties": { - "parameters": { - "$ref": "#/definitions/PiiTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "PiiEntityRecognition" - }, - "PiiTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/PiiResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "PiiEntityRecognitionResults" - }, - "PiiResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/PiiEntitiesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "PiiDomain": { - "type": "string", - "description": "The PII domain used for PII Entity Recognition.", - "default": "none", - "enum": [ - "phi", - "none" - ], - "x-ms-enum": { - "name": "PiiDomain", - "modelAsString": true, - "values": [ - { - "name": "phi", - "description": "Indicates that entities in the Personal Health Information domain should be redacted.", - "value": "phi" - }, - { - "name": "none", - "description": "Indicates that no domain is specified.", - "value": "none" - } - ] - } - }, - "PiiEntitiesDocumentResult": { - "type": "object", - "properties": { - "redactedText": { - "type": "string", - "description": "Returns redacted text." - }, - "entities": { - "type": "array", - "description": "Recognized entities in the document.", - "items": { - "$ref": "#/definitions/Entity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "redactedText", - "entities" - ] - }, - "PiiCategories": { - "description": "(Optional) describes the PII categories to return", - "items": { - "type": "string", - "x-ms-enum": { - "name": "PiiCategory", - "modelAsString": true - }, - "enum": [ - "ABARoutingNumber", - "ARNationalIdentityNumber", - "AUBankAccountNumber", - "AUDriversLicenseNumber", - "AUMedicalAccountNumber", - "AUPassportNumber", - "AUTaxFileNumber", - "AUBusinessNumber", - "AUCompanyNumber", - "ATIdentityCard", - "ATTaxIdentificationNumber", - "ATValueAddedTaxNumber", - "AzureDocumentDBAuthKey", - "AzureIAASDatabaseConnectionAndSQLString", - "AzureIoTConnectionString", - "AzurePublishSettingPassword", - "AzureRedisCacheString", - "AzureSAS", - "AzureServiceBusString", - "AzureStorageAccountKey", - "AzureStorageAccountGeneric", - "BENationalNumber", - "BENationalNumberV2", - "BEValueAddedTaxNumber", - "BRCPFNumber", - "BRLegalEntityNumber", - "BRNationalIDRG", - "BGUniformCivilNumber", - "CABankAccountNumber", - "CADriversLicenseNumber", - "CAHealthServiceNumber", - "CAPassportNumber", - "CAPersonalHealthIdentification", - "CASocialInsuranceNumber", - "CLIdentityCardNumber", - "CNResidentIdentityCardNumber", - "CreditCardNumber", - "HRIdentityCardNumber", - "HRNationalIDNumber", - "HRPersonalIdentificationNumber", - "HRPersonalIdentificationOIBNumberV2", - "CYIdentityCard", - "CYTaxIdentificationNumber", - "CZPersonalIdentityNumber", - "CZPersonalIdentityV2", - "DKPersonalIdentificationNumber", - "DKPersonalIdentificationV2", - "DrugEnforcementAgencyNumber", - "EEPersonalIdentificationCode", - "EUDebitCardNumber", - "EUDriversLicenseNumber", - "EUGPSCoordinates", - "EUNationalIdentificationNumber", - "EUPassportNumber", - "EUSocialSecurityNumber", - "EUTaxIdentificationNumber", - "FIEuropeanHealthNumber", - "FINationalID", - "FINationalIDV2", - "FIPassportNumber", - "FRDriversLicenseNumber", - "FRHealthInsuranceNumber", - "FRNationalID", - "FRPassportNumber", - "FRSocialSecurityNumber", - "FRTaxIdentificationNumber", - "FRValueAddedTaxNumber", - "DEDriversLicenseNumber", - "DEPassportNumber", - "DEIdentityCardNumber", - "DETaxIdentificationNumber", - "DEValueAddedNumber", - "GRNationalIDCard", - "GRNationalIDV2", - "GRTaxIdentificationNumber", - "HKIdentityCardNumber", - "HUValueAddedNumber", - "HUPersonalIdentificationNumber", - "HUTaxIdentificationNumber", - "INPermanentAccount", - "INUniqueIdentificationNumber", - "IDIdentityCardNumber", - "InternationalBankingAccountNumber", - "IEPersonalPublicServiceNumber", - "IEPersonalPublicServiceNumberV2", - "ILBankAccountNumber", - "ILNationalID", - "ITDriversLicenseNumber", - "ITFiscalCode", - "ITValueAddedTaxNumber", - "JPBankAccountNumber", - "JPDriversLicenseNumber", - "JPPassportNumber", - "JPResidentRegistrationNumber", - "JPSocialInsuranceNumber", - "JPMyNumberCorporate", - "JPMyNumberPersonal", - "JPResidenceCardNumber", - "LVPersonalCode", - "LTPersonalCode", - "LUNationalIdentificationNumberNatural", - "LUNationalIdentificationNumberNonNatural", - "MYIdentityCardNumber", - "MTIdentityCardNumber", - "MTTaxIDNumber", - "NLCitizensServiceNumber", - "NLCitizensServiceNumberV2", - "NLTaxIdentificationNumber", - "NLValueAddedTaxNumber", - "NZBankAccountNumber", - "NZDriversLicenseNumber", - "NZInlandRevenueNumber", - "NZMinistryOfHealthNumber", - "NZSocialWelfareNumber", - "NOIdentityNumber", - "PHUnifiedMultiPurposeIDNumber", - "PLIdentityCard", - "PLNationalID", - "PLNationalIDV2", - "PLPassportNumber", - "PLTaxIdentificationNumber", - "PLREGONNumber", - "PTCitizenCardNumber", - "PTCitizenCardNumberV2", - "PTTaxIdentificationNumber", - "ROPersonalNumericalCode", - "RUPassportNumberDomestic", - "RUPassportNumberInternational", - "SANationalID", - "SGNationalRegistrationIdentityCardNumber", - "SKPersonalNumber", - "SITaxIdentificationNumber", - "SIUniqueMasterCitizenNumber", - "ZAIdentificationNumber", - "KRResidentRegistrationNumber", - "ESDNI", - "ESSocialSecurityNumber", - "ESTaxIdentificationNumber", - "SQLServerConnectionString", - "SENationalID", - "SENationalIDV2", - "SEPassportNumber", - "SETaxIdentificationNumber", - "SWIFTCode", - "CHSocialSecurityNumber", - "TWNationalID", - "TWPassportNumber", - "TWResidentCertificate", - "THPopulationIdentificationCode", - "TRNationalIdentificationNumber", - "UKDriversLicenseNumber", - "UKElectoralRollNumber", - "UKNationalHealthNumber", - "UKNationalInsuranceNumber", - "UKUniqueTaxpayerNumber", - "USUKPassportNumber", - "USBankAccountNumber", - "USDriversLicenseNumber", - "USIndividualTaxpayerIdentification", - "USSocialSecurityNumber", - "UAPassportNumberDomestic", - "UAPassportNumberInternational", - "Organization", - "Email", - "URL", - "Age", - "PhoneNumber", - "IPAddress", - "Date", - "Person", - "Address", - "All", - "Default" - ] - }, - "type": "array", - "uniqueItems": true - }, - "ExtractiveSummarizationTaskParameters": { - "type": "object", - "description": "Supported parameters for an Extractive Summarization task.", - "properties": { - "sentenceCount": { - "type": "integer", - "default": 3 - }, - "sortBy": { - "$ref": "#/definitions/ExtractiveSummarizationSortingCriteria" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - }, - "ExtractiveSummarizationLROTask": { - "type": "object", - "description": "An object representing the task definition for an Extractive Summarization task.", - "properties": { - "parameters": { - "$ref": "#/definitions/ExtractiveSummarizationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "ExtractiveSummarization" - }, - "ExtractiveSummarizationResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/ExtractedSummaryDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "ExtractiveSummarizationSortingCriteria": { - "type": "string", - "default": "Offset", - "description": "The sorting criteria to use for the results of Extractive Summarization.", - "enum": [ - "Offset", - "Rank" - ], - "x-ms-enum": { - "name": "ExtractiveSummarizationSortingCriteria", - "modelAsString": true, - "values": [ - { - "name": "Offset", - "description": "Indicates that results should be sorted in order of appearance in the text.", - "value": "Offset" - }, - { - "name": "Rank", - "description": "Indicates that results should be sorted in order of importance (i.e. rank score) according to the model.", - "value": "Rank" - } - ] - } - }, - "ExtractedSummaryDocumentResult": { - "type": "object", - "properties": { - "sentences": { - "type": "array", - "description": "A ranked list of sentences representing the extracted summary.", - "items": { - "$ref": "#/definitions/ExtractedSummarySentence" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "sentences" - ] - }, - "ExtractedSummarySentence": { - "type": "object", - "required": [ - "text", - "rankScore", - "offset", - "length" - ], - "properties": { - "text": { - "type": "string", - "description": "The extracted sentence text." - }, - "rankScore": { - "type": "number", - "format": "double", - "description": "A double value representing the relevance of the sentence within the summary. Higher values indicate higher importance." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The sentence offset from the start of the document, based on the value of the parameter StringIndexType." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the sentence." - } - } - }, - "KeyPhraseTaskParameters": { - "type": "object", - "description": "Supported parameters for a Key Phrase Extraction task.", - "allOf": [ - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - }, - "KeyPhraseLROTask": { - "type": "object", - "description": "An object representing the task definition for a Key Phrase Extraction task.", - "properties": { - "parameters": { - "$ref": "#/definitions/KeyPhraseTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "KeyPhraseExtraction" - }, - "KeyPhraseTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/KeyPhraseResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "KeyPhraseExtractionResults" - }, - "KeyPhraseResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/KeyPhrasesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "KeyPhrasesDocumentResult": { - "type": "object", - "properties": { - "keyPhrases": { - "type": "array", - "description": "A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.", - "items": { - "type": "string" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "keyPhrases" - ] - }, - "LanguageDetectionTaskParameters": { - "type": "object", - "description": "Supported parameters for a Language Detection task.", - "allOf": [ - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - }, - "LanguageDetectionTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/LanguageDetectionResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "LanguageDetectionResults" - }, - "LanguageDetectionResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "$ref": "#/definitions/LanguageDetectionDocumentResult" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "LanguageDetectionDocumentResult": { - "type": "object", - "properties": { - "detectedLanguage": { - "description": "Detected Language.", - "$ref": "#/definitions/DetectedLanguage" - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "detectedLanguage" - ] - }, - "DetectedLanguage": { - "type": "object", - "required": [ - "name", - "iso6391Name", - "confidenceScore" - ], - "properties": { - "name": { - "type": "string", - "description": "Long name of a detected language (e.g. English, French)." - }, - "iso6391Name": { - "type": "string", - "description": "A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr)." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true." - } - } - }, - "AnalyzeTextJobState": { - "allOf": [ - { - "$ref": "#/definitions/JobState" - }, - { - "$ref": "#/definitions/TasksState" - }, - { - "$ref": "#/definitions/AnalyzeTextJobStatistics" - } - ] - }, - "Pagination": { - "properties": { - "nextLink": { - "type": "string" - } - }, - "type": "object" - }, - "JobMetadata": { - "properties": { - "displayName": { - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "type": "string" - }, - "jobId": { - "format": "uuid", - "type": "string" - }, - "lastUpdateDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { - "enum": [ - "notStarted", - "running", - "succeeded", - "partiallySucceeded", - "failed", - "cancelled", - "cancelling" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": false, - "name": "State" - } - } - }, - "required": [ - "jobId", - "lastUpdateDateTime", - "createdDateTime", - "status" - ], - "type": "object" - }, - "JobState": { - "properties": { - "displayName": { - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "type": "string" - }, - "jobId": { - "format": "uuid", - "type": "string" - }, - "lastUpdateDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { - "enum": [ - "notStarted", - "running", - "succeeded", - "partiallySucceeded", - "failed", - "cancelled", - "cancelling" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": false, - "name": "State" - } - }, - "errors": { - "items": { - "$ref": "common.json#/definitions/Error" - }, - "type": "array" - }, - "nextLink": { - "type": "string" - } - }, - "required": [ - "jobId", - "lastUpdateDateTime", - "createdDateTime", - "status" - ] - }, - "JobErrors": { - "properties": { - "errors": { - "items": { - "$ref": "common.json#/definitions/Error" - }, - "type": "array" - } - }, - "type": "object" - }, - "AnalyzeTextJobStatistics": { - "properties": { - "statistics": { - "$ref": "#/definitions/RequestStatistics" - } - }, - "type": "object" - }, - "TasksState": { - "properties": { - "tasks": { - "properties": { - "completed": { - "type": "integer" - }, - "failed": { - "type": "integer" - }, - "inProgress": { - "type": "integer" - }, - "total": { - "type": "integer" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - } - }, - "required": [ - "total", - "completed", - "failed", - "inProgress" - ], - "type": "object" - } - }, - "required": [ - "tasks" - ], - "type": "object" - }, - "TaskState": { - "properties": { - "lastUpdateDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling" - ], - "x-ms-enum": { - "modelAsString": false, - "name": "State" - } - } - }, - "required": [ - "status", - "lastUpdateDateTime" - ], - "type": "object" - }, - "AnalyzeTextLROResult": { - "type": "object", - "discriminator": "kind", - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextLROResultsKind" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskState" - }, - { - "$ref": "#/definitions/TaskIdentifier" - } - ], - "required": [ - "kind" - ] - }, - "EntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityRecognitionLROResults" - }, - "CustomEntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomEntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomEntityRecognitionLROResults" - }, - "CustomSingleLabelClassificationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomSingleLabelClassificationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomSingleLabelClassificationLROResults" - }, - "CustomMultiLabelClassificationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomMultiLabelClassificationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomMultiLabelClassificationLROResults" - }, - "EntityLinkingLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntityLinkingResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityLinkingLROResults" - }, - "PiiEntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/PiiResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "PiiEntityRecognitionLROResults" - }, - "ExtractiveSummarizationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/ExtractiveSummarizationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "ExtractiveSummarizationLROResults" - }, - "HealthcareLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/HealthcareResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "HealthcareLROResults" - }, - "SentimentLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/SentimentResponse" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "SentimentAnalysisLROResults" - }, - "KeyPhraseExtractionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/KeyPhraseResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "KeyPhraseExtractionLROResults" - }, - "DocumentResponse": { - "type": "object", - "properties": {} - }, - "DocumentResult": { - "type": "object", - "required": [ - "id", - "warnings" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique, non-empty document identifier." - }, - "warnings": { - "type": "array", - "description": "Warnings encountered while processing document.", - "items": { - "$ref": "#/definitions/DocumentWarning" - } - }, - "statistics": { - "description": "if showStats=true was specified in the request this field will contain information about the document payload.", - "$ref": "#/definitions/DocumentStatistics" - } - } - }, - "DocumentError": { - "type": "object", - "required": [ - "id", - "error" - ], - "properties": { - "id": { - "type": "string", - "description": "Document Id." - }, - "error": { - "type": "object", - "description": "Document Error.", - "$ref": "common.json#/definitions/Error" - } - } - }, - "DocumentWarning": { - "type": "object", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "LongWordsInDocument", - "DocumentTruncated" - ], - "x-ms-enum": { - "name": "WarningCodeValue", - "modelAsString": true - }, - "description": "Error code." - }, - "message": { - "type": "string", - "description": "Warning message." - }, - "targetRef": { - "type": "string", - "description": "A JSON pointer reference indicating the target object." - } - } - }, - "DocumentStatistics": { - "type": "object", - "required": [ - "charactersCount", - "transactionsCount" - ], - "properties": { - "charactersCount": { - "type": "integer", - "format": "int32", - "description": "Number of text elements recognized in the document." - }, - "transactionsCount": { - "type": "integer", - "format": "int32", - "description": "Number of transactions for the document." - } - }, - "description": "if showStats=true was specified in the request this field will contain information about the document payload." - }, - "RequestStatistics": { - "type": "object", - "required": [ - "documentsCount", - "validDocumentsCount", - "erroneousDocumentsCount", - "transactionsCount" - ], - "properties": { - "documentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of documents submitted in the request." - }, - "validDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." - }, - "erroneousDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." - }, - "transactionsCount": { - "type": "integer", - "format": "int64", - "description": "Number of transactions for the request." - } - }, - "description": "if showStats=true was specified in the request this field will contain information about the request payload." - }, - "MultiLanguageInput": { - "type": "object", - "description": "Contains an input document to be analyzed by the service.", - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "A unique, non-empty document identifier." - }, - "text": { - "type": "string", - "description": "The input text to process." - }, - "language": { - "type": "string", - "description": "(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." - } - } - }, - "LanguageInput": { - "type": "object", - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique, non-empty document identifier." - }, - "text": { - "type": "string" - }, - "countryHint": { - "type": "string" - } - } - } - }, - "parameters": { - "ShowStats": { - "name": "showStats", - "in": "query", - "description": "(Optional) if set to true, response will contain request and document level statistics.", - "type": "boolean", - "required": false, - "x-ms-parameter-location": "method" - }, - "JobId": { - "description": "Job ID", - "format": "uuid", - "in": "path", - "name": "jobId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/common.json b/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/common.json deleted file mode 100644 index 4e07e508b914..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/common.json +++ /dev/null @@ -1,248 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2022-03-01-preview" - }, - "paths": {}, - "definitions": { - "ErrorResponse": { - "type": "object", - "description": "Error response.", - "additionalProperties": false, - "properties": { - "error": { - "description": "The error object.", - "$ref": "#/definitions/Error" - } - }, - "required": [ - "error" - ] - }, - "Error": { - "type": "object", - "description": "The error object.", - "additionalProperties": true, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/ErrorCode" - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - }, - "target": { - "type": "string", - "description": "The target of the error." - }, - "details": { - "type": "array", - "description": "An array of details about specific errors that led to this reported error.", - "items": { - "$ref": "#/definitions/Error" - } - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "InnerErrorModel": { - "type": "object", - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", - "additionalProperties": false, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/InnerErrorCode" - }, - "message": { - "type": "string", - "description": "Error message." - }, - "details": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Error details." - }, - "target": { - "type": "string", - "description": "Error target." - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "ErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "ErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidArgument", - "Unauthorized", - "Forbidden", - "NotFound", - "ProjectNotFound", - "OperationNotFound", - "AzureCognitiveSearchNotFound", - "AzureCognitiveSearchIndexNotFound", - "TooManyRequests", - "AzureCognitiveSearchThrottling", - "AzureCognitiveSearchIndexLimitReached", - "InternalServerError", - "ServiceUnavailable" - ] - }, - "InnerErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "InnerErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidParameterValue", - "KnowledgeBaseNotFound", - "AzureCognitiveSearchNotFound", - "AzureCognitiveSearchThrottling", - "ExtractionFailure", - "InvalidRequestBodyFormat", - "EmptyRequest", - "MissingInputDocuments", - "InvalidDocument", - "ModelVersionIncorrect", - "InvalidDocumentBatch", - "UnsupportedLanguageCode", - "InvalidCountryHint" - ] - }, - "Language": { - "type": "string", - "description": "Language of the text records. This is BCP-47 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." - }, - "StringIndexType": { - "type": "string", - "description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.", - "default": "TextElements_v8", - "enum": [ - "TextElements_v8", - "UnicodeCodePoint", - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "TextElements_v8", - "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." - }, - { - "value": "UnicodeCodePoint", - "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." - }, - { - "value": "Utf16CodeUnit", - "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - } - } - }, - "parameters": { - "Endpoint": { - "name": "Endpoint", - "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - "ProjectNameQueryParameter": { - "name": "projectName", - "in": "query", - "required": true, - "type": "string", - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "ProjectNamePathParameter": { - "name": "projectName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 100, - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNameQueryParameter": { - "name": "deploymentName", - "in": "query", - "required": true, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNamePathParameter": { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - }, - "TopParameter": { - "name": "top", - "in": "query", - "description": "The maximum number of resources to return from the collection.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "SkipParameter": { - "name": "skip", - "in": "query", - "description": "An offset into the collection of the first resource to be returned.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "MaxPageSizeParameter": { - "name": "maxpagesize", - "in": "query", - "description": "The maximum number of resources to include in a single response.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulAnalyzeTextJobsCancelRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulAnalyzeTextJobsCancelRequest.json deleted file mode 100644 index 06b3dbf3eaf6..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulAnalyzeTextJobsCancelRequest.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "ApiVersion": "2022-03-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2022-03-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json deleted file mode 100644 index 10023beba7fc..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json +++ /dev/null @@ -1,131 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-03-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Extracting Location & US Region", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 2, - "failed": 0, - "inProgress": 0, - "total": 2, - "items": [ - { - "kind": "EntityRecognitionLROResults", - "taskName": "Recognize Entities", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "entities": [ - { - "category": "Event", - "confidenceScore": 0.61, - "length": 4, - "offset": 18, - "text": "trip" - }, - { - "category": "Location", - "confidenceScore": 0.82, - "length": 7, - "offset": 26, - "subcategory": "GPE", - "text": "Seattle" - }, - { - "category": "DateTime", - "confidenceScore": 0.8, - "length": 9, - "offset": 34, - "subcategory": "DateRange", - "text": "last week" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "Location", - "confidenceScore": 0.52, - "length": 3, - "offset": 14, - "subcategory": "GPE", - "text": "NYC" - }, - { - "category": "DateTime", - "confidenceScore": 0.8, - "length": 8, - "offset": 18, - "subcategory": "Date", - "text": "tomorrow" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-04-01" - } - }, - { - "kind": "CustomEntityRecognitionLROResults", - "taskName": "Recognize US Regions", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "entities": [ - { - "category": "USRegion", - "confidenceScore": 0.85, - "length": 17, - "offset": 45, - "text": "Pacific Northwest" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "USRegion", - "confidenceScore": 0.88, - "length": 10, - "offset": 63, - "text": "East Coast" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "projectName": "MyProject", - "deploymentName": "MyDeployment" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json deleted file mode 100644 index 54a7ead22202..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-03-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Extracting Location & US Region", - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "I had a wonderful trip to Seattle last week." - }, - { - "id": "2", - "language": "en", - "text": "I'm flying to NYC tomorrow. See you there." - } - ] - }, - "tasks": [ - { - "kind": "EntityRecognition", - "taskName": "Recognize Entities", - "parameters": { - "modelVersion": "latest" - } - }, - { - "kind": "CustomEntityRecognition", - "taskName": "Recognize US Regions", - "parameters": { - "projectName": "MyProject", - "deploymentName": "MyDeployment" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulEntityLinkingRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulEntityLinkingRequest.json deleted file mode 100644 index 97a03f6b48a0..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulEntityLinkingRequest.json +++ /dev/null @@ -1,128 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-03-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "EntityLinking", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Microsoft was founded by Bill Gates and Paul Allen." - }, - { - "id": "2", - "language": "en", - "text": "Pike place market is my favorite Seattle attraction." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "EntityLinkingResults", - "results": { - "documents": [ - { - "entities": [ - { - "dataSource": "Wikipedia", - "id": "Bill Gates", - "language": "en", - "matches": [ - { - "confidenceScore": 0.52, - "length": 10, - "offset": 25, - "text": "Bill Gates" - } - ], - "name": "Bill Gates", - "url": "https://en.wikipedia.org/wiki/Bill_Gates" - }, - { - "dataSource": "Wikipedia", - "id": "Paul Allen", - "language": "en", - "matches": [ - { - "confidenceScore": 0.54, - "length": 10, - "offset": 40, - "text": "Paul Allen" - } - ], - "name": "Paul Allen", - "url": "https://en.wikipedia.org/wiki/Paul_Allen" - }, - { - "dataSource": "Wikipedia", - "id": "Microsoft", - "language": "en", - "matches": [ - { - "confidenceScore": 0.49, - "length": 9, - "offset": 0, - "text": "Microsoft" - } - ], - "name": "Microsoft", - "url": "https://en.wikipedia.org/wiki/Microsoft" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "dataSource": "Wikipedia", - "id": "Pike Place Market", - "language": "en", - "matches": [ - { - "confidenceScore": 0.86, - "length": 17, - "offset": 0, - "text": "Pike place market" - } - ], - "name": "Pike Place Market", - "url": "https://en.wikipedia.org/wiki/Pike_Place_Market" - }, - { - "dataSource": "Wikipedia", - "id": "Seattle", - "language": "en", - "matches": [ - { - "confidenceScore": 0.27, - "length": 7, - "offset": 33, - "text": "Seattle" - } - ], - "name": "Seattle", - "url": "https://en.wikipedia.org/wiki/Seattle" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-02-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulEntityRecognitionRequest.json deleted file mode 100644 index ff33bc7851fe..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulEntityRecognitionRequest.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-03-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "EntityRecognition", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Microsoft was founded by Bill Gates and Paul Allen." - }, - { - "id": "2", - "language": "en", - "text": "Pike place market is my favorite Seattle attraction." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "EntityRecognitionResults", - "results": { - "documents": [ - { - "entities": [ - { - "category": "Organization", - "confidenceScore": 0.84, - "length": 9, - "offset": 0, - "text": "Microsoft" - }, - { - "category": "Person", - "confidenceScore": 0.85, - "length": 10, - "offset": 25, - "text": "Bill Gates" - }, - { - "category": "Person", - "confidenceScore": 0.9, - "length": 10, - "offset": 40, - "text": "Paul Allen" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "Location", - "confidenceScore": 0.55, - "length": 7, - "offset": 33, - "subcategory": "GPE", - "text": "Seattle" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-04-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulKeyPhraseExtractionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulKeyPhraseExtractionRequest.json deleted file mode 100644 index 3dc676d2131f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulKeyPhraseExtractionRequest.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-03-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "KeyPhraseExtraction", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Microsoft was founded by Bill Gates and Paul Allen." - }, - { - "id": "2", - "language": "en", - "text": "Text Analytics is one of the Azure Cognitive Services." - }, - { - "id": "3", - "language": "en", - "text": "My cat might need to see a veterinarian." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "KeyPhraseExtractionResults", - "results": { - "documents": [ - { - "id": "1", - "keyPhrases": [ - "Bill Gates", - "Paul Allen", - "Microsoft" - ], - "warnings": [] - }, - { - "id": "2", - "keyPhrases": [ - "Azure Cognitive Services", - "Text Analytics" - ], - "warnings": [] - }, - { - "id": "3", - "keyPhrases": [ - "cat", - "veterinarian" - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2019-10-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulLanguageDetectionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulLanguageDetectionRequest.json deleted file mode 100644 index 6f497da543a7..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulLanguageDetectionRequest.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-03-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "LanguageDetection", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "text": "Hello world" - }, - { - "id": "2", - "text": "Bonjour tout le monde" - }, - { - "id": "3", - "text": "Hola mundo" - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "LanguageDetectionResults", - "results": { - "documents": [ - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "en", - "name": "English" - }, - "id": "1", - "warnings": [] - }, - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "fr", - "name": "French" - }, - "id": "2", - "warnings": [] - }, - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "es", - "name": "Spanish" - }, - "id": "3", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-04-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulPiiEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulPiiEntityRecognitionRequest.json deleted file mode 100644 index 9c644f773fb8..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulPiiEntityRecognitionRequest.json +++ /dev/null @@ -1,88 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-03-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "PiiEntityRecognition", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "My SSN is 859-98-0987" - }, - { - "id": "2", - "language": "en", - "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." - }, - { - "id": "3", - "language": "en", - "text": "Is 998.214.865-68 your Brazilian CPF number?" - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "PiiEntityRecognitionResults", - "results": { - "documents": [ - { - "id": "1", - "redactedText": "My SSN is ***********", - "entities": [ - { - "category": "U.S. Social Security Number (SSN)", - "confidenceScore": 0.65, - "length": 11, - "offset": 28, - "text": "859-98-0987" - } - ], - "warnings": [] - }, - { - "id": "2", - "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", - "entities": [ - { - "category": "ABA Routing Number", - "confidenceScore": 0.75, - "length": 9, - "offset": 18, - "text": "111000025" - } - ], - "warnings": [] - }, - { - "id": "3", - "redactedText": "Is ************** your Brazilian CPF number?", - "entities": [ - { - "category": "Brazil CPF Number", - "confidenceScore": 0.85, - "length": 14, - "offset": 3, - "text": "998.214.865-68" - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2019-10-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulSentimentAnalysisRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulSentimentAnalysisRequest.json deleted file mode 100644 index 9feb2d4cc123..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/SuccessfulSentimentAnalysisRequest.json +++ /dev/null @@ -1,148 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-03-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "SentimentAnalysis", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "SentimentAnalysisResults", - "results": { - "documents": [ - { - "confidenceScores": { - "negative": 0, - "neutral": 0, - "positive": 1 - }, - "id": "1", - "sentences": [ - { - "targets": [ - { - "confidenceScores": { - "negative": 0, - "positive": 1 - }, - "length": 10, - "offset": 6, - "relations": [ - { - "ref": "#/documents/0/sentences/0/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "atmosphere" - } - ], - "confidenceScores": { - "negative": 0, - "neutral": 0, - "positive": 1 - }, - "length": 17, - "offset": 0, - "assessments": [ - { - "confidenceScores": { - "negative": 0, - "positive": 1 - }, - "isNegated": false, - "length": 5, - "offset": 0, - "sentiment": "positive", - "text": "great" - } - ], - "sentiment": "positive", - "text": "Great atmosphere." - }, - { - "targets": [ - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "length": 11, - "offset": 37, - "relations": [ - { - "ref": "#/documents/0/sentences/1/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "restaurants" - }, - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "length": 6, - "offset": 50, - "relations": [ - { - "ref": "#/documents/0/sentences/1/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "hotels" - } - ], - "confidenceScores": { - "negative": 0.01, - "neutral": 0.86, - "positive": 0.13 - }, - "length": 52, - "offset": 18, - "assessments": [ - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "isNegated": false, - "length": 15, - "offset": 18, - "sentiment": "positive", - "text": "Close to plenty" - } - ], - "sentiment": "neutral", - "text": "Close to plenty of restaurants, hotels, and transit!" - } - ], - "sentiment": "positive", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-04-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/conversations/Conversation_project.json b/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/conversations/Conversation_project.json deleted file mode 100644 index b9b1fa7767f1..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/conversations/Conversation_project.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-03-01-preview", - "body": { - "kind": "CustomConversation", - "analysisInput": { - "conversationItem": { - "language": "en-GB", - "text": "play a song from Phil Collins", - "participantId": "1", - "modality": "text", - "id": "1" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "verbose": true, - "isLoggingEnabled": false, - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "CustomConversationResult", - "results": { - "query": "play In the air tonight from Phil Collins", - "detectedLanguage": "en", - "prediction": { - "topIntent": "PlayMusic", - "projectKind": "conversation", - "intents": [ - { - "category": "PlayMusic", - "confidenceScore": 1 - }, - { - "category": "SearchCreativeWork", - "confidenceScore": 0 - }, - { - "category": "AddToPlaylist", - "confidenceScore": 0 - } - ], - "entities": [ - { - "category": "Media.Artist", - "text": "Phil Collins", - "offset": 29, - "length": 12, - "confidenceScore": 1 - } - ] - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/conversations/Orchestrator_arbitration.json b/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/conversations/Orchestrator_arbitration.json deleted file mode 100644 index b7ab6102a15a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/conversations/Orchestrator_arbitration.json +++ /dev/null @@ -1,79 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-03-01-preview", - "body": { - "kind": "CustomConversation", - "analysisInput": { - "conversationItem": { - "participantId": "1", - "id": "1", - "modality": "text", - "language": "en-GB", - "text": "How do I integrate QnA Maker and LUIS?" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "verbose": true, - "isLoggingEnabled": false, - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "CustomConversationResult", - "results": { - "query": "trains from London", - "prediction": { - "topIntent": "Rail", - "projectKind": "workflow", - "intents": { - "Rail": { - "confidenceScore": 1, - "targetKind": "conversation", - "apiVersion": null, - "result": { - "query": "trains from London", - "prediction": { - "intents": [ - { - "category": "Timetable", - "confidenceScore": 0.99968535 - }, - { - "category": "Locomotive", - "confidenceScore": 0.000314623 - } - ], - "entities": [], - "topIntent": "Timetable", - "projectKind": "conversation" - } - } - }, - "Tree": { - "confidenceScore": 0.2641529, - "targetKind": "conversation", - "apiVersion": null, - "result": null - }, - "None": { - "confidenceScore": 0, - "targetKind": "non_linked", - "apiVersion": null, - "result": null - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/conversations/Orchestrator_direct_target.json b/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/conversations/Orchestrator_direct_target.json deleted file mode 100644 index da7f68136621..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/examples/conversations/Orchestrator_direct_target.json +++ /dev/null @@ -1,113 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2021-11-01-preview", - "body": { - "kind": "CustomConversation", - "analysisInput": { - "conversationItem": { - "language": "en-GB", - "text": "play a song from Phil Collins", - "participantId": "1", - "modality": "text", - "id": "1" - } - }, - "parameters": { - "projectName": "prj1", - "deploymentName": "dep1", - "isLoggingEnabled": false, - "verbose": true, - "stringIndexType": "TextElement_V8", - "directTarget": "qnaProject", - "targetProjectParameters": { - "qnaProject": { - "targetKind": "question_answering", - "callingOptions": { - "context": { - "previousQuery": "Meet Surface Pro 4", - "previousQnAId": 4 - }, - "top": 3, - "isTest": true, - "userId": "Default", - "question": "Ports and connectors" - }, - "apiVersion": "v5.1" - } - } - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "CustomConversationResult", - "results": { - "query": "Ports and connectors", - "prediction": { - "projectKind": "workflow", - "topIntent": "qnaTargetApp", - "intents": { - "qnaTargetApp": { - "targetKind": "question_answering", - "apiVersion": "v5.1", - "confidenceScore": 0.913329, - "result": { - "answers": [ - { - "questions": [ - "Power and charging" - ], - "answer": "Power and charging**\n\nIt takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you are using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.\n\nYou can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface.", - "confidenceScore": 0.65, - "id": 20, - "source": "surface-pro-4-user-guide-EN.pdf", - "metadata": { - "category": "api", - "editorial": "chitchat" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 23, - "displayText": "prompt1" - }, - { - "displayOrder": 2, - "qnaId": 36, - "displayText": "prompt2" - } - ] - }, - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0.3, - "offset": 33, - "length": 50 - } - }, - { - "questions": [ - "Charge your Surface Pro 4" - ], - "answer": "**Charge your Surface Pro 4**\n\n1. Connect the two parts of the power cord.\n\n2. Connect the power cord securely to the charging port.\n\n3. Plug the power supply into an electrical outlet.", - "confidenceScore": 0.32, - "id": 13, - "source": "surface-pro-4-user-guide-EN.pdf" - } - ] - } - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/analyzeconversations-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/analyzeconversations-authoring.json deleted file mode 100644 index 207dba8bb82a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/analyzeconversations-authoring.json +++ /dev/null @@ -1,3102 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Analyze Conversations Authoring", - "version": "2022-05-15-preview", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview." - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/authoring/analyze-conversations/projects": { - "get": { - "description": "Lists the existing projects.", - "operationId": "ConversationalAnalysisAuthoring_ListProjects", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of projects.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectsMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Projects": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListProjects.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}": { - "patch": { - "description": "Creates a new project or updates an existing one.", - "operationId": "ConversationalAnalysisAuthoring_CreateProject", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The project parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of the updated project, if it already exists.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "201": { - "description": "The metadata of the created project.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Create Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateProject.json" - } - } - }, - "get": { - "description": "Gets the details of a project.", - "operationId": "ConversationalAnalysisAuthoring_GetProject", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of the project.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProject.json" - } - } - }, - "delete": { - "description": "Deletes a project.", - "operationId": "ConversationalAnalysisAuthoring_DeleteProject", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/:export": { - "post": { - "description": "Triggers a job to export a project's data.", - "operationId": "ConversationalAnalysisAuthoring_Export", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" - }, - { - "in": "query", - "name": "assetKind", - "description": "Kind of asset to export.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Export Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulExportProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/:import": { - "post": { - "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", - "operationId": "ConversationalAnalysisAuthoring_Import", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryParameter" - }, - { - "in": "body", - "name": "body", - "description": "The project data to import.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProject" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Import Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulImportProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/:train": { - "post": { - "description": "Triggers a training job for a project.", - "operationId": "ConversationalAnalysisAuthoring_Train", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The training input parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Train Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulTrainProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments": { - "get": { - "description": "Lists the deployments belonging to a project.", - "operationId": "ConversationalAnalysisAuthoring_ListDeployments", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all deployments.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployments" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeployments.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { - "post": { - "description": "Swaps two existing deployments with each other.", - "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The job object to swap two deployments.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Swap Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": { - "get": { - "description": "Gets the details of a deployment.", - "operationId": "ConversationalAnalysisAuthoring_GetDeployment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The Deployment info.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeployment.json" - } - } - }, - "put": { - "description": "Creates a new deployment or replaces an existing one.", - "operationId": "ConversationalAnalysisAuthoring_DeployProject", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The new deployment info.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateDeploymentOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Deploy Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeployProject.json" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "description": "Deletes a project deployment.", - "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing deployment job.", - "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The deployment job result.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Deployment Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing swap deployment job.", - "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The swap deployment job result.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Swap Deployments Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": { - "get": { - "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", - "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The status of the long running operation.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportProjectJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Export Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { - "get": { - "description": "Gets the status for an import.", - "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The details of the long running operation.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringImportProjectJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Import Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models": { - "get": { - "description": "Lists the trained models belonging to a project.", - "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all trained models.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModels" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Models": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListModels.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": { - "get": { - "description": "Gets the details of a trained model.", - "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Trained model info", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModel.json" - } - } - }, - "delete": { - "description": "Deletes an existing trained model.", - "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "204": { - "description": "Deleted successfully." - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteModel.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { - "get": { - "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", - "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of the evaluation predictions.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationResults" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model Evaluation": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { - "get": { - "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", - "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all evaluation results.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationSummary" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model Evaluation Summary": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/train/jobs": { - "get": { - "description": "Lists the non-expired training jobs created for a project.", - "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of the training jobs.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobs" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Training Jobs": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": { - "get": { - "description": "Gets the status for a training job.", - "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The training job result.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Train Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": { - "post": { - "description": "Triggers a cancellation for a running training job.", - "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the job cancellation.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Cancel Training Job": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": { - "get": { - "description": "Gets the status for a project deletion job.", - "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The project deletion job result.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeletionJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Project Deletion Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/global/languages": { - "get": { - "description": "Lists the supported languages for the given project type.", - "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of supported languages.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguages" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Supported Languages": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/global/prebuilt-entities": { - "get": { - "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", - "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "language", - "description": "The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "in": "query", - "name": "multilingual", - "description": "Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of supported prebuilt entities.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntities" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Supported Prebuilt Entities": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/global/training-config-versions": { - "get": { - "description": "Lists the support training config version for a given project type.", - "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of config versions.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersions" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Supported Training Config Versions": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - } - }, - "definitions": { - "ConversationalAnalysisAuthoringCompositionSetting": { - "enum": [ - "returnLongestOverlap", - "requireExactOverlap", - "separateComponents", - "combineComponents" - ], - "type": "string", - "x-ms-enum": { - "name": "CompositionSetting", - "modelAsString": true, - "values": [ - { - "value": "returnLongestOverlap", - "description": "When two or more components are found in the text and overlap, the component with the longest set of characters is returned." - }, - { - "value": "requireExactOverlap", - "description": "All components must overlap at the exact same characters in the text for the entity to return. If one of the defined components is not matched or predicted, the entity will not return." - }, - { - "value": "separateComponents", - "description": "Every component's match or prediction is returned as a separate instance of the entity." - }, - { - "value": "combineComponents", - "description": "When two or more components are found in the text and overlap, the components' spans are merged together into one span combining all of them." - } - ] - }, - "x-ms-client-name": "CompositionSetting" - }, - "ConversationalAnalysisAuthoringConfusionMatrix": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixRow" - }, - "x-ms-client-name": "ConfusionMatrix" - }, - "ConversationalAnalysisAuthoringConfusionMatrixCell": { - "description": "Represents a cell in a confusion matrix.", - "required": [ - "normalizedValue", - "rawValue" - ], - "type": "object", - "properties": { - "normalizedValue": { - "format": "float", - "description": "Represents normalized value in percentages.", - "type": "number" - }, - "rawValue": { - "format": "float", - "description": "Represents raw value.", - "type": "number" - } - }, - "x-ms-client-name": "ConfusionMatrixCell" - }, - "ConversationalAnalysisAuthoringConfusionMatrixRow": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixCell" - }, - "x-ms-client-name": "ConfusionMatrixRow" - }, - "ConversationalAnalysisAuthoringConversationExportedEntity": { - "description": "Represents an entity with its components.", - "required": [ - "category" - ], - "type": "object", - "properties": { - "category": { - "description": "The category of the entity.", - "type": "string" - }, - "compositionSetting": { - "description": "The behavior to follow when the entity's components overlap with each other.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringCompositionSetting" - }, - "list": { - "description": "The list component of the entity.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityList" - }, - "prebuilts": { - "description": "The prebuilt entities components.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedPrebuiltEntity" - } - } - }, - "x-ms-client-name": "ConversationExportedEntity" - }, - "ConversationalAnalysisAuthoringConversationExportedIntent": { - "description": "Represents an exported intent of a conversational project.", - "required": [ - "category" - ], - "type": "object", - "properties": { - "category": { - "description": "The intent category.", - "type": "string" - } - }, - "x-ms-client-name": "ConversationExportedIntent" - }, - "ConversationalAnalysisAuthoringConversationExportedProjectAssets": { - "description": "Represents the exported assets of a conversational project.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" - } - ], - "properties": { - "intents": { - "description": "The intents defined in the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedIntent" - } - }, - "entities": { - "description": "The entities defined in the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedEntity" - } - }, - "utterances": { - "description": "The utterances defined in the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedUtterance" - } - } - }, - "x-ms-discriminator-value": "Conversation", - "x-ms-client-name": "ConversationExportedProjectAssets" - }, - "ConversationalAnalysisAuthoringConversationExportedUtterance": { - "description": "Represents an exported utterance for a conversational project.", - "required": [ - "text", - "intent" - ], - "type": "object", - "properties": { - "entities": { - "description": "Represents the entity labels of the utterance.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedUtteranceEntityLabel" - } - }, - "text": { - "description": "The utterance text.", - "type": "string" - }, - "language": { - "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "intent": { - "description": "The intent of the utterance.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "ConversationExportedUtterance" - }, - "ConversationalAnalysisAuthoringCreateDeploymentOptions": { - "description": "Represents the options for creating or updating a project deployment.", - "required": [ - "trainedModelLabel" - ], - "type": "object", - "properties": { - "trainedModelLabel": { - "description": "Represents the trained model label.", - "type": "string" - } - }, - "x-ms-client-name": "CreateDeploymentOptions" - }, - "ConversationalAnalysisAuthoringCreateProjectOptions": { - "description": "Represents the options used to create or update a project.", - "required": [ - "projectKind", - "projectName", - "language" - ], - "type": "object", - "properties": { - "projectKind": { - "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" - }, - "settings": { - "description": "The project settings.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" - }, - "projectName": { - "description": "The new project name.", - "type": "string" - }, - "multilingual": { - "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" - }, - "description": { - "description": "The project description.", - "type": "string" - }, - "language": { - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "CreateProjectOptions" - }, - "ConversationalAnalysisAuthoringDeploymentJobState": { - "description": "Represents the state of a deployment job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "DeploymentJobState" - }, - "ConversationalAnalysisAuthoringEntitiesEvaluationSummary": { - "description": "Represents the evaluation result summary for the project's entities.", - "required": [ - "confusionMatrix", - "entities", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], - "type": "object", - "properties": { - "confusionMatrix": { - "description": "Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" - }, - "entities": { - "description": "Represents the entities evaluation summary.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringEntityEvaluationSummary" - } - }, - "microF1": { - "format": "float", - "description": "Represents the micro F1", - "type": "number" - }, - "microPrecision": { - "format": "float", - "description": "Represents the micro precision", - "type": "number" - }, - "microRecall": { - "format": "float", - "description": "Represents the micro recall", - "type": "number" - }, - "macroF1": { - "format": "float", - "description": "Represents the macro F1", - "type": "number" - }, - "macroPrecision": { - "format": "float", - "description": "Represents the macro precision", - "type": "number" - }, - "macroRecall": { - "format": "float", - "description": "Represents the macro recall", - "type": "number" - } - }, - "x-ms-client-name": "EntitiesEvaluationSummary" - }, - "ConversationalAnalysisAuthoringEntityEvaluationSummary": { - "description": "Represents the evaluation result for an entity.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], - "type": "object", - "properties": { - "f1": { - "format": "double", - "description": "Represents the model precision", - "type": "number" - }, - "precision": { - "format": "double", - "description": "Represents the model recall", - "type": "number" - }, - "recall": { - "format": "double", - "description": "Represents the model F1 score", - "type": "number" - }, - "truePositiveCount": { - "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" - }, - "trueNegativeCount": { - "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" - }, - "falsePositiveCount": { - "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" - }, - "falseNegativeCount": { - "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" - } - }, - "x-ms-client-name": "EntityEvaluationSummary" - }, - "ConversationalAnalysisAuthoringEvaluationKind": { - "enum": [ - "percentage", - "manual" - ], - "type": "string", - "x-ms-enum": { - "name": "EvaluationKind", - "modelAsString": true, - "values": [ - { - "value": "percentage", - "description": "Split the data into training and test sets according to user-defined percentages." - }, - { - "value": "manual", - "description": "Split the data according to the chosen dataset for every example in the data." - } - ] - }, - "x-ms-client-name": "EvaluationKind" - }, - "ConversationalAnalysisAuthoringEvaluationOptions": { - "description": "Represents the options used running the evaluation.", - "type": "object", - "properties": { - "kind": { - "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationKind" - }, - "trainingSplitPercentage": { - "format": "int32", - "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" - }, - "testingSplitPercentage": { - "format": "int32", - "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" - } - }, - "x-ms-client-name": "EvaluationOptions" - }, - "ConversationalAnalysisAuthoringEvaluationResults": { - "description": "Represent a list of utterances' evaluation results.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The utterances evaluation results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEvaluationResult" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "EvaluationResults" - }, - "ConversationalAnalysisAuthoringEvaluationSummary": { - "description": "Represents the evaluation result summary.", - "required": [ - "entitiesEvaluation", - "intentsEvaluation" - ], - "type": "object", - "properties": { - "entitiesEvaluation": { - "description": "Contains the data related to entities evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEntitiesEvaluationSummary" - }, - "intentsEvaluation": { - "description": "Contains the data related to intents evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentsEvaluationSummary" - }, - "evaluationOptions": { - "description": "The options that were used while running the evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" - } - }, - "x-ms-client-name": "EvaluationSummary" - }, - "ConversationalAnalysisAuthoringExportedConversationOrchestration": { - "description": "Defines the orchestration details for a Conversational project target.", - "required": [ - "projectName", - "deploymentName" - ], - "type": "object", - "properties": { - "projectName": { - "description": "The name of the targeted project.", - "type": "string" - }, - "deploymentName": { - "description": "The name of the targeted deployment.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedConversationOrchestration" - }, - "ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions": { - "description": "Represents the orchestration options for a Conversational project target.", - "required": [ - "conversationOrchestration" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" - } - ], - "properties": { - "conversationOrchestration": { - "description": "The Conversational project target details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedConversationOrchestration" - } - }, - "x-ms-discriminator-value": "Conversation", - "x-ms-client-name": "ExportedConversationOrchestrationOptions" - }, - "ConversationalAnalysisAuthoringExportedEntityList": { - "description": "Represents a list component of an entity.", - "type": "object", - "properties": { - "sublists": { - "description": "The sub-lists of the list component.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntitySublist" - } - } - }, - "x-ms-client-name": "ExportedEntityList" - }, - "ConversationalAnalysisAuthoringExportedEntityListSynonym": { - "description": "Represents a list of synonyms inside a list component", - "type": "object", - "properties": { - "language": { - "description": "Represents the language of the synonyms. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "values": { - "description": "The list of synonyms.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ms-client-name": "ExportedEntityListSynonym" - }, - "ConversationalAnalysisAuthoringExportedEntitySublist": { - "description": "Represents a sub-list inside a list component.", - "type": "object", - "properties": { - "listKey": { - "description": "The key of the sub-list.", - "type": "string" - }, - "synonyms": { - "description": "The phrases of that correspond to the sub-list.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityListSynonym" - } - } - }, - "x-ms-client-name": "ExportedEntitySublist" - }, - "ConversationalAnalysisAuthoringExportedLuisOrchestration": { - "description": "Defines the orchestration details for a LUIS application target.", - "required": [ - "appId" - ], - "type": "object", - "properties": { - "appId": { - "format": "uuid", - "description": "The LUIS application ID.", - "type": "string", - "example": "00000000-0000-0000-0000-000000000000" - }, - "appVersion": { - "description": "The targeted version Id.", - "type": "string" - }, - "slotName": { - "description": "The targeted slot name.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedLuisOrchestration" - }, - "ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions": { - "description": "Represents the orchestration options for a LUIS application target.", - "required": [ - "luisOrchestration" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" - } - ], - "properties": { - "luisOrchestration": { - "description": "The LUIS application target details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedLuisOrchestration" - } - }, - "x-ms-discriminator-value": "Luis", - "x-ms-client-name": "ExportedLuisOrchestrationOptions" - }, - "ConversationalAnalysisAuthoringExportedOrchestrationOptions": { - "description": "Represents the options used to define the orchestration behavior of an intent.", - "required": [ - "targetProjectKind" - ], - "type": "object", - "properties": { - "targetProjectKind": { - "description": "The kind of the target used in the orchestration flow.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationTargetProjectKind" - } - }, - "discriminator": "targetProjectKind", - "x-ms-client-name": "ExportedOrchestrationOptions" - }, - "ConversationalAnalysisAuthoringExportedPrebuiltEntity": { - "description": "Represents an exported prebuilt entity component", - "required": [ - "category" - ], - "type": "object", - "properties": { - "category": { - "description": "The prebuilt entity category.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedPrebuiltEntity" - }, - "ConversationalAnalysisAuthoringExportedProject": { - "description": "Represents an exported project.", - "required": [ - "projectFileVersion", - "stringIndexType", - "metadata" - ], - "type": "object", - "properties": { - "projectFileVersion": { - "description": "The version of the exported file.", - "type": "string" - }, - "stringIndexType": { - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringStringIndexType" - }, - "metadata": { - "description": "Represents the project metadata.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" - }, - "assets": { - "description": "Represents the project assets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" - } - }, - "x-ms-client-name": "ExportedProject" - }, - "ConversationalAnalysisAuthoringExportedProjectAssets": { - "description": "Represents the assets of an exported project.", - "required": [ - "projectKind" - ], - "type": "object", - "properties": { - "projectKind": { - "description": "The type of project containing the assets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" - } - }, - "discriminator": "projectKind", - "x-ms-client-name": "ExportedProjectAssets" - }, - "ConversationalAnalysisAuthoringExportedProjectFormat": { - "enum": [ - "Conversation", - "Luis" - ], - "type": "string", - "x-ms-enum": { - "name": "ExportedProjectFormat", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "Specifies the format for a conversational project." - }, - { - "value": "Luis", - "description": "Specifies the format for an application that was exported from LUIS." - } - ] - }, - "x-ms-client-name": "ExportedProjectFormat" - }, - "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration": { - "description": "Defines the orchestration details for a Question Answering project target.", - "required": [ - "projectName" - ], - "type": "object", - "properties": { - "projectName": { - "description": "The name of the target project.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedQuestionAnsweringOrchestration" - }, - "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions": { - "description": "Represents the orchestration options for a Question Answering project target.", - "required": [ - "questionAnsweringOrchestration" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" - } - ], - "properties": { - "questionAnsweringOrchestration": { - "description": "The Question Answering project details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration" - } - }, - "x-ms-discriminator-value": "QuestionAnswering", - "x-ms-client-name": "ExportedQuestionAnsweringOrchestrationOptions" - }, - "ConversationalAnalysisAuthoringExportedUtteranceEntityLabel": { - "description": "Represents an entity label for an utterance.", - "required": [ - "category", - "offset", - "length" - ], - "type": "object", - "properties": { - "category": { - "description": "The category of the entity label.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "Start position for the entity text.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "Length for the entity text.", - "type": "integer" - } - }, - "x-ms-client-name": "ExportedUtteranceEntityLabel" - }, - "ConversationalAnalysisAuthoringExportProjectJobState": { - "description": "Represents the state of an export job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "properties": { - "resultUrl": { - "description": "The URL to use in order to download the exported project.", - "type": "string" - } - }, - "x-ms-client-name": "ExportProjectJobState" - }, - "ConversationalAnalysisAuthoringImportProjectJobState": { - "description": "Represents the state of an import job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "ImportProjectJobState" - }, - "ConversationalAnalysisAuthoringIntentEvaluationSummary": { - "description": "The evaluation summary for an intent.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], - "type": "object", - "properties": { - "f1": { - "format": "double", - "description": "Represents the model precision", - "type": "number" - }, - "precision": { - "format": "double", - "description": "Represents the model recall", - "type": "number" - }, - "recall": { - "format": "double", - "description": "Represents the model F1 score", - "type": "number" - }, - "truePositiveCount": { - "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" - }, - "trueNegativeCount": { - "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" - }, - "falsePositiveCount": { - "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" - }, - "falseNegativeCount": { - "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" - } - }, - "x-ms-client-name": "IntentEvaluationSummary" - }, - "ConversationalAnalysisAuthoringIntentsEvaluationSummary": { - "description": "Represents the evaluation summary for the project's intents.", - "required": [ - "confusionMatrix", - "intents", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], - "type": "object", - "properties": { - "confusionMatrix": { - "description": "Represents the confusion matrix between two intents (the two intents can be the same). The matrix is between the intent that was labelled and the intent that was predicted.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" - }, - "intents": { - "description": "Represents the intents evaluation summary.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentEvaluationSummary" - } - }, - "microF1": { - "format": "float", - "description": "Represents the micro F1", - "type": "number" - }, - "microPrecision": { - "format": "float", - "description": "Represents the micro precision", - "type": "number" - }, - "microRecall": { - "format": "float", - "description": "Represents the micro recall", - "type": "number" - }, - "macroF1": { - "format": "float", - "description": "Represents the macro F1", - "type": "number" - }, - "macroPrecision": { - "format": "float", - "description": "Represents the macro precision", - "type": "number" - }, - "macroRecall": { - "format": "float", - "description": "Represents the macro recall", - "type": "number" - } - }, - "x-ms-client-name": "IntentsEvaluationSummary" - }, - "ConversationalAnalysisAuthoringJobState": { - "description": "Represents a job's state.", - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ], - "type": "object", - "properties": { - "jobId": { - "description": "The job ID.", - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "description": "The creation date time of the job.", - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "description": "The last date time the job was updated.", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "description": "The expiration date time of the job.", - "type": "string" - }, - "status": { - "description": "The job status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" - }, - "warnings": { - "description": "The warnings that were encountered while executing the job.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringWarning" - } - }, - "errors": { - "description": "The errors encountered while executing the job.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - } - }, - "x-ms-client-name": "JobState" - }, - "ConversationalAnalysisAuthoringJobStatus": { - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling", - "partiallyCompleted" - ], - "type": "string", - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true - }, - "x-ms-client-name": "JobStatus" - }, - "ConversationalAnalysisAuthoringOrchestrationExportedIntent": { - "description": "Represents an exported intent for an orchestration project.", - "required": [ - "category" - ], - "type": "object", - "properties": { - "orchestration": { - "description": "Specifies the behavior of this intent in the orchestration flow.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" - }, - "category": { - "description": "The intent category.", - "type": "string" - } - }, - "x-ms-client-name": "OrchestrationExportedIntent" - }, - "ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets": { - "description": "Represents the assets of an orchestration project.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" - } - ], - "properties": { - "intents": { - "description": "Represents the intents of the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedIntent" - } - }, - "utterances": { - "description": "Represents the utterances of the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedUtterance" - } - } - }, - "x-ms-discriminator-value": "Orchestration", - "x-ms-client-name": "OrchestrationExportedProjectAssets" - }, - "ConversationalAnalysisAuthoringOrchestrationExportedUtterance": { - "description": "Represents an utterance of an orchestration project.", - "required": [ - "text", - "intent" - ], - "type": "object", - "properties": { - "text": { - "description": "The utterance text.", - "type": "string" - }, - "language": { - "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "intent": { - "description": "The intent of the utterance.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "OrchestrationExportedUtterance" - }, - "ConversationalAnalysisAuthoringOrchestrationTargetProjectKind": { - "enum": [ - "Luis", - "Conversation", - "QuestionAnswering" - ], - "type": "string", - "x-ms-enum": { - "name": "OrchestrationTargetProjectKind", - "modelAsString": true - }, - "x-ms-client-name": "OrchestrationTargetProjectKind" - }, - "ConversationalAnalysisAuthoringPrebuiltEntities": { - "description": "Represents a list of the retrieved supported prebuilt entities.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The supported prebuilt entities.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntity" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "PrebuiltEntities" - }, - "ConversationalAnalysisAuthoringPrebuiltEntity": { - "description": "Represents a supported prebuilt entity.", - "required": [ - "category", - "description", - "examples" - ], - "type": "object", - "properties": { - "category": { - "description": "The prebuilt entity category.", - "type": "string" - }, - "description": { - "description": "The description.", - "type": "string" - }, - "examples": { - "description": "English examples for the entity.", - "type": "string" - } - }, - "x-ms-client-name": "PrebuiltEntity" - }, - "ConversationalAnalysisAuthoringProjectDeletionJobState": { - "description": "Represents the state of a project deletion job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "ProjectDeletionJobState" - }, - "ConversationalAnalysisAuthoringProjectDeployment": { - "description": "Represents a project deployment.", - "required": [ - "deploymentName", - "modelId", - "lastTrainedDateTime", - "lastDeployedDateTime", - "deploymentExpirationDate", - "modelTrainingConfigVersion" - ], - "type": "object", - "properties": { - "deploymentName": { - "description": "Represents deployment name.", - "type": "string" - }, - "modelId": { - "description": "Represents deployment modelId.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "Represents deployment last trained time.", - "type": "string" - }, - "lastDeployedDateTime": { - "format": "date-time", - "description": "Represents deployment last deployed time.", - "type": "string" - }, - "deploymentExpirationDate": { - "format": "date", - "description": "Represents deployment expiration date in the runtime.", - "type": "string" - }, - "modelTrainingConfigVersion": { - "description": "Represents model training config version.", - "type": "string" - } - }, - "x-ms-client-name": "ProjectDeployment" - }, - "ConversationalAnalysisAuthoringProjectDeployments": { - "description": "Represents a list of retrieved deployments.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved deployments.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectDeployments" - }, - "ConversationalAnalysisAuthoringProjectKind": { - "enum": [ - "Conversation", - "Orchestration" - ], - "type": "string", - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "A project to build natural language into apps, bots, and IoT devices." - }, - { - "value": "Orchestration", - "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." - } - ] - }, - "x-ms-client-name": "ProjectKind" - }, - "ConversationalAnalysisAuthoringProjectMetadata": { - "description": "Represents the metadata of a project.", - "required": [ - "createdDateTime", - "lastModifiedDateTime", - "projectKind", - "projectName", - "language" - ], - "type": "object", - "properties": { - "createdDateTime": { - "format": "date-time", - "description": "Represents the project creation datetime.", - "type": "string" - }, - "lastModifiedDateTime": { - "format": "date-time", - "description": "Represents the project creation datetime.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "Represents the project last trained datetime.", - "type": "string" - }, - "lastDeployedDateTime": { - "format": "date-time", - "description": "Represents the project last deployed datetime.", - "type": "string" - }, - "projectKind": { - "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" - }, - "settings": { - "description": "The project settings.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" - }, - "projectName": { - "description": "The new project name.", - "type": "string" - }, - "multilingual": { - "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" - }, - "description": { - "description": "The project description.", - "type": "string" - }, - "language": { - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "ProjectMetadata" - }, - "ConversationalAnalysisAuthoringProjectSettings": { - "description": "Represents the settings used to define the project behavior.", - "required": [ - "confidenceThreshold" - ], - "type": "object", - "properties": { - "confidenceThreshold": { - "format": "float", - "description": "The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to \"None\".", - "type": "number" - } - }, - "x-ms-client-name": "ProjectSettings" - }, - "ConversationalAnalysisAuthoringProjectsMetadata": { - "description": "Represents a list of retrieved projects' metadata.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of projects.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectsMetadata" - }, - "ConversationalAnalysisAuthoringProjectTrainedModel": { - "description": "Represents a trained model.", - "required": [ - "label", - "modelId", - "lastTrainedDateTime", - "lastTrainingDurationInSeconds", - "modelExpirationDate", - "modelTrainingConfigVersion" - ], - "type": "object", - "properties": { - "label": { - "description": "The trained model label.", - "type": "string" - }, - "modelId": { - "description": "The model ID.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "The last trained date time of the model.", - "type": "string" - }, - "lastTrainingDurationInSeconds": { - "format": "int32", - "description": "The duration of the model's last training request in seconds.", - "type": "integer" - }, - "modelExpirationDate": { - "format": "date", - "description": "The model expiration date.", - "type": "string" - }, - "modelTrainingConfigVersion": { - "description": "The model training config version.", - "type": "string" - } - }, - "x-ms-client-name": "ProjectTrainedModel" - }, - "ConversationalAnalysisAuthoringProjectTrainedModels": { - "description": "Represents a list of retrieved trained models.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved jobs.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectTrainedModels" - }, - "ConversationalAnalysisAuthoringStringIndexType": { - "enum": [ - "Utf16CodeUnit" - ], - "type": "string", - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - }, - "x-ms-client-name": "StringIndexType" - }, - "ConversationalAnalysisAuthoringSubTrainingJobState": { - "description": "Represents the detailed state of a training sub-operation.", - "required": [ - "percentComplete", - "status" - ], - "type": "object", - "properties": { - "percentComplete": { - "format": "int32", - "description": "Represents progress percentage.", - "type": "integer" - }, - "startDateTime": { - "format": "date-time", - "description": "Represents the start date time.", - "type": "string" - }, - "endDateTime": { - "format": "date-time", - "description": "Represents the end date time.", - "type": "string" - }, - "status": { - "description": "Represents the status of the sub-operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" - } - }, - "x-ms-client-name": "SubTrainingJobState" - }, - "ConversationalAnalysisAuthoringSupportedLanguage": { - "description": "Represents a supported language.", - "required": [ - "languageName", - "languageCode" - ], - "type": "object", - "properties": { - "languageName": { - "description": "The language name.", - "type": "string" - }, - "languageCode": { - "description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "SupportedLanguage" - }, - "ConversationalAnalysisAuthoringSupportedLanguages": { - "description": "Represents a list of retrieved languages.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of the languages.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguage" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "SupportedLanguages" - }, - "ConversationalAnalysisAuthoringSwapDeploymentsOptions": { - "description": "Represents the options for swapping two deployments together.", - "required": [ - "firstDeploymentName", - "secondDeploymentName" - ], - "type": "object", - "properties": { - "firstDeploymentName": { - "description": "Represents the first deployment name.", - "type": "string" - }, - "secondDeploymentName": { - "description": "Represents the second deployment name.", - "type": "string" - } - }, - "x-ms-client-name": "SwapDeploymentsOptions" - }, - "ConversationalAnalysisAuthoringTrainingConfigVersion": { - "description": "Represents a training config version.", - "required": [ - "trainingConfigVersion", - "modelExpirationDate" - ], - "type": "object", - "properties": { - "trainingConfigVersion": { - "description": "Represents the version of the config.", - "type": "string" - }, - "modelExpirationDate": { - "format": "date", - "description": "Represents the training config version expiration date.", - "type": "string" - } - }, - "x-ms-client-name": "TrainingConfigVersion" - }, - "ConversationalAnalysisAuthoringTrainingConfigVersions": { - "description": "Represents a list of training config versions.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of the training config versions.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersion" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "TrainingConfigVersions" - }, - "ConversationalAnalysisAuthoringTrainingJobOptions": { - "description": "Represents the options for starting a new training job.", - "required": [ - "modelLabel", - "trainingMode" - ], - "type": "object", - "properties": { - "modelLabel": { - "description": "Represents the output model label.", - "type": "string" - }, - "trainingConfigVersion": { - "description": "Represents training config version. By default, \"latest\" value is used which uses the latest released training config version.", - "type": "string" - }, - "trainingMode": { - "description": "Represents the mode of the training operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" - }, - "evaluationOptions": { - "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" - } - }, - "x-ms-client-name": "TrainingJobOptions" - }, - "ConversationalAnalysisAuthoringTrainingJobResult": { - "description": "Represents the output of a training job.", - "required": [ - "modelLabel", - "trainingConfigVersion", - "trainingStatus" - ], - "type": "object", - "properties": { - "modelLabel": { - "description": "Represents trained model label.", - "type": "string" - }, - "trainingConfigVersion": { - "description": "Represents training config version.", - "type": "string" - }, - "trainingMode": { - "description": "Represents the mode of the training operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" - }, - "trainingStatus": { - "description": "Represents the model training status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" - }, - "evaluationStatus": { - "description": "Represents model evaluation status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" - }, - "estimatedEndDateTime": { - "format": "date-time", - "description": "Represents the estimated end date time for training and evaluation.", - "type": "string" - } - }, - "x-ms-client-name": "TrainingJobResult" - }, - "ConversationalAnalysisAuthoringTrainingJobs": { - "description": "Represents a list of retrieved training jobs.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of jobs.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "TrainingJobs" - }, - "ConversationalAnalysisAuthoringTrainingJobState": { - "description": "Represents the state of a training job.", - "required": [ - "result" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "properties": { - "result": { - "description": "Represents training tasks detailed result.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobResult" - } - }, - "x-ms-client-name": "TrainingJobState" - }, - "ConversationalAnalysisAuthoringTrainingMode": { - "enum": [ - "advanced", - "standard" - ], - "type": "string", - "x-ms-enum": { - "name": "TrainingMode", - "modelAsString": true, - "values": [ - { - "value": "advanced", - "description": "Trains using fine-tuned neural network transformer models. Can train multilingual projects." - }, - { - "value": "standard", - "description": "Faster training times for quicker iterations." - } - ] - }, - "x-ms-client-name": "TrainingMode" - }, - "ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult": { - "description": "Represents the comparison between the expected and predicted entities for an utterance.", - "required": [ - "expectedEntities", - "predictedEntities" - ], - "type": "object", - "properties": { - "expectedEntities": { - "description": "Represents the expected entity labels.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" - } - }, - "predictedEntities": { - "description": "Represents the predicted entity labels.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" - } - } - }, - "x-ms-client-name": "UtteranceEntitiesEvaluationResult" - }, - "ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult": { - "description": "Represents the evaluation output of an entity label or prediction.", - "required": [ - "category", - "offset", - "length" - ], - "type": "object", - "properties": { - "category": { - "description": "Represents the entity category.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "Represents the entity offset index relative to the original text.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "Represents the entity length.", - "type": "integer" - } - }, - "x-ms-client-name": "UtteranceEntityEvaluationResult" - }, - "ConversationalAnalysisAuthoringUtteranceEvaluationResult": { - "description": "Represents the evaluation result for an utterance.", - "required": [ - "text", - "language", - "entitiesResult", - "intentsResult" - ], - "type": "object", - "properties": { - "text": { - "description": "Represents the utterance text.", - "type": "string" - }, - "language": { - "description": "Represents the utterance language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "entitiesResult": { - "description": "Represents the entities results for the utterance.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult" - }, - "intentsResult": { - "description": "Represents the intents results for the utterance.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult" - } - }, - "x-ms-client-name": "UtteranceEvaluationResult" - }, - "ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult": { - "description": "Represents the comparison between the expected and the predicted intent for an utterance.", - "required": [ - "expectedIntent", - "predictedIntent" - ], - "type": "object", - "properties": { - "expectedIntent": { - "description": "Represents the utterance's expected intent.", - "type": "string" - }, - "predictedIntent": { - "description": "Represents the utterance's predicted intent.", - "type": "string" - } - }, - "x-ms-client-name": "UtteranceIntentsEvaluationResult" - }, - "ConversationalAnalysisAuthoringWarning": { - "description": "Represents a warning that was encountered while executing the request.", - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "description": "The warning code.", - "type": "string" - }, - "message": { - "description": "The warning message.", - "type": "string" - } - }, - "x-ms-client-name": "Warning" - } - }, - "parameters": { - "ConversationalAnalysisAuthoringFormatQueryParameter": { - "in": "query", - "name": "format", - "description": "The format of the exported project file to use.", - "type": "string", - "enum": [ - "Conversation", - "Luis" - ], - "x-ms-enum": { - "name": "ExportedProjectFormat", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "Specifies the format for a conversational project." - }, - { - "value": "Luis", - "description": "Specifies the format for an application that was exported from LUIS." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "ConversationalAnalysisAuthoringStringIndexTypeQueryParameter": { - "in": "query", - "name": "stringIndexType", - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "required": true, - "type": "string", - "enum": [ - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "ConversationalAnalysisAuthoringJobIdPathParameter": { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ConversationalAnalysisAuthoringTrainedModelLabelPathParameter": { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model label.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ConversationalAnalysisAuthoringProjectKindQueryParameter": { - "in": "query", - "name": "projectKind", - "description": "The project kind.", - "required": true, - "type": "string", - "enum": [ - "Conversation", - "Orchestration" - ], - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "A project to build natural language into apps, bots, and IoT devices." - }, - { - "value": "Orchestration", - "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." - } - ] - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/analyzeconversations.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/analyzeconversations.json deleted file mode 100644 index fbeffab78637..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/analyzeconversations.json +++ /dev/null @@ -1,2300 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Analyze Conversations", - "description": "The language service conversations API is a suite of natural language processing (NLP) skills that can be used to analyze structured conversations (textual or spoken). The synchronous API in this suite accepts a request and mediates among multiple language projects, such as LUIS Generally Available, Question Answering, Conversational Language Understanding, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload.\n\n In some cases, this API needs to forward requests and responses between the caller and an upstream service. The asynchronous APIs in this suite enable tasks like Conversation Summarization and Conversational PII detection.", - "version": "2022-05-15-preview" - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/:analyze-conversations": { - "post": { - "operationId": "ConversationAnalysis_AnalyzeConversation", - "description": "Analyzes the input conversation utterance.", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "A single conversational task to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeConversationTask" - }, - "required": true - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The conversation analysis response.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationTaskResult" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" - } - } - } - }, - "x-ms-examples": { - "Conversation project result": { - "$ref": "./examples/conversations/SuccessfulAnalyzeConversations.json" - }, - "Arbitration result": { - "$ref": "./examples/conversations/SuccessfulAnalyzeConversationsArbitration.json" - }, - "Orchestrator direct target result": { - "$ref": "./examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json" - } - } - } - }, - "/analyze-conversations/jobs": { - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "description": "Submit a collection of conversations for analysis. Specify one or more unique tasks to be executed.", - "operationId": "AnalyzeConversation_SubmitJob", - "summary": "Submit analysis job for conversations", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "The collection of conversations to analyze and one or more tasks to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeConversationJobsInput" - }, - "required": true - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Conversational PII Analysis Job Request": { - "$ref": "./examples/conversations/SuccessfulConversationPIISubmit.json" - }, - "Successful Conversation Summarization Analysis Job Request": { - "$ref": "./examples/conversations/SuccessfulConversationSummarySubmit.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/analyze-conversations/jobs/{jobId}": { - "get": { - "produces": [ - "application/json" - ], - "description": "Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are succeeded, the job will transition to the succeeded state and results will be available for each task.", - "operationId": "AnalyzeConversation_JobStatus", - "summary": "Get analysis status and results", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/JobId" - }, - { - "$ref": "common.json#/parameters/ShowStats" - } - ], - "responses": { - "200": { - "description": "Analysis job status and metadata.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationJobState" - } - }, - "default": { - "description": "Error encountered.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Conversation PII Analysis Job Status Request": { - "$ref": "./examples/conversations/SuccessfulConversationPIITaskStatusRequest.json" - }, - "Successful Get Text Conversation Analysis Job Status Request": { - "$ref": "./examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json" - } - } - } - }, - "/analyze-conversations/jobs/{jobId}:cancel": { - "post": { - "produces": [ - "application/json" - ], - "description": "Cancel a long-running Text Analysis conversations job.", - "operationId": "AnalyzeConversation_CancelJob", - "summary": "Cancel a long-running Text Analysis conversations job", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/JobId" - } - ], - "responses": { - "202": { - "description": "Cancel Job request has been received.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Job Delete Request": { - "$ref": ".//examples//conversations//SuccessfulAnalyzeConversationsJobsCancelRequest.json" - } - }, - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "AnalyzeConversationTaskKind": { - "type": "string", - "description": "Enumeration of supported Conversation tasks.", - "enum": [ - "Conversation" - ], - "x-ms-enum": { - "name": "AnalyzeConversationTaskKind", - "modelAsString": true - } - }, - "AnalyzeConversationTaskResultsKind": { - "type": "string", - "description": "Enumeration of supported conversational task results", - "enum": [ - "ConversationResult" - ], - "x-ms-enum": { - "name": "AnalyzeConversationTaskResultsKind", - "modelAsString": true - } - }, - "AnalyzeConversationTask": { - "description": "The base class of a conversation input task.", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationTaskKind" - } - } - }, - "AnalyzeConversationTaskResult": { - "description": "The base class of a conversation task result.", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationTaskResultsKind" - } - } - }, - "ConversationalTask": { - "description": "The input for a custom conversation task.", - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationTask" - } - ], - "properties": { - "analysisInput": { - "$ref": "#/definitions/ConversationAnalysisOptions" - }, - "parameters": { - "$ref": "#/definitions/ConversationTaskParameters" - } - }, - "x-ms-discriminator-value": "Conversation", - "required": [ - "analysisInput", - "parameters" - ] - }, - "ConversationTaskParameters": { - "type": "object", - "description": "Input parameters necessary for a Conversation task.", - "properties": { - "projectName": { - "type": "string", - "description": "The name of the project to use." - }, - "deploymentName": { - "type": "string", - "description": "The name of the deployment to use." - }, - "verbose": { - "type": "boolean", - "description": "If true, the service will return more detailed information in the response." - }, - "isLoggingEnabled": { - "type": "boolean", - "description": "If true, the service will keep the query for further review." - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - }, - "directTarget": { - "type": "string", - "description": "The name of a target project to forward the request to." - }, - "targetProjectParameters": { - "type": "object", - "description": "A dictionary representing the parameters for each target project.", - "additionalProperties": { - "$ref": "#/definitions/AnalysisParameters" - } - } - }, - "required": [ - "projectName", - "deploymentName" - ] - }, - "ConversationalTaskResult": { - "description": "The results of a Conversation task.", - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationTaskResult" - } - ], - "type": "object", - "properties": { - "result": { - "$ref": "#/definitions/AnalyzeConversationResult" - } - }, - "required": [ - "result" - ], - "x-ms-discriminator-value": "ConversationResult" - }, - "ConversationItemBase": { - "type": "object", - "description": "The abstract base for a user input formatted conversation (e.g., Text, Transcript).", - "properties": { - "id": { - "description": "The ID of a conversation item.", - "type": "string" - }, - "participantId": { - "description": "The participant ID of a conversation item.", - "type": "string" - }, - "language": { - "description": "The override language of a conversation item in BCP 47 language representation.", - "type": "string" - }, - "modality": { - "$ref": "#/definitions/Modality" - }, - "role": { - "type": "string", - "description": "The role of the participant.", - "enum": [ - "agent", - "customer", - "generic" - ], - "x-ms-enum": { - "name": "role", - "modelAsString": true - } - } - }, - "required": [ - "participantId", - "id" - ], - "additionalProperties": true - }, - "TextConversationItem": { - "description": "The text modality of an input conversation.", - "allOf": [ - { - "$ref": "#/definitions/ConversationItemBase" - } - ], - "properties": { - "text": { - "description": "The text input", - "type": "string" - } - }, - "required": [ - "text" - ] - }, - "ConversationAnalysisOptions": { - "type": "object", - "description": "The input ConversationItem and its optional parameters", - "required": [ - "conversationItem" - ], - "properties": { - "conversationItem": { - "$ref": "#/definitions/ConversationItemBase" - } - } - }, - "AnalysisParameters": { - "type": "object", - "description": "This is the parameter set of either the Orchestration project itself or one of the target services.", - "required": [ - "targetProjectKind" - ], - "discriminator": "targetProjectKind", - "properties": { - "targetProjectKind": { - "type": "string", - "description": "The type of a target service.", - "enum": [ - "Luis", - "Conversation", - "QuestionAnswering", - "NonLinked" - ], - "x-ms-enum": { - "name": "targetProjectKind", - "modelAsString": true - } - }, - "apiVersion": { - "type": "string", - "description": "The API version to use when call a specific target service." - } - } - }, - "NoneLinkedTargetIntentResult": { - "type": "object", - "description": "A wrap up of non-linked intent response.", - "x-ms-discriminator-value": "NonLinked", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "$ref": "#/definitions/ConversationResult", - "description": "The actual response from a Conversation project." - } - } - }, - "LuisParameters": { - "description": "This is a set of request parameters for LUIS Generally Available projects.", - "x-ms-discriminator-value": "Luis", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "query": { - "type": "string", - "maxLength": 500, - "description": "The utterance to predict." - }, - "callingOptions": { - "type": "object", - "description": "This customizes how the service calls LUIS Generally Available projects.", - "$ref": "#/definitions/LuisCallingOptions" - } - }, - "additionalProperties": true - }, - "LuisCallingOptions": { - "description": "This customizes how the service calls LUIS Generally Available projects.", - "type": "object", - "properties": { - "verbose": { - "description": "Enable verbose response.", - "type": "boolean" - }, - "log": { - "description": "Save log to add in training utterances later.", - "type": "boolean" - }, - "show-all-intents": { - "description": "Set true to show all intents.", - "type": "boolean" - }, - "timezoneOffset": { - "type": "number", - "description": "The timezone offset for the location of the request." - }, - "spellCheck": { - "type": "boolean", - "description": "Enable spell checking." - }, - "bing-spell-check-subscription-key": { - "description": "The subscription key to use when enabling Bing spell check", - "type": "string" - } - } - }, - "ConversationParameters": { - "type": "object", - "description": "This is a set of request parameters for Customized Conversation projects.", - "x-ms-discriminator-value": "Conversation", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "callingOptions": { - "type": "object", - "$ref": "#/definitions/ConversationCallingOptions" - } - } - }, - "ConversationCallingOptions": { - "type": "object", - "description": "The option to set to call a Conversation project.", - "properties": { - "language": { - "description": "The language of the query in BCP 47 language representation..", - "type": "string" - }, - "verbose": { - "description": "If true, the service will return more detailed information.", - "type": "boolean" - }, - "isLoggingEnabled": { - "description": "If true, the query will be saved for customers to further review in authoring, to improve the model quality.", - "type": "boolean" - } - } - }, - "QuestionAnsweringParameters": { - "type": "object", - "description": "This is a set of request parameters for Question Answering knowledge bases.", - "x-ms-discriminator-value": "QuestionAnswering", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "callingOptions": { - "description": "The options sent to a Question Answering KB.", - "$ref": "common.json#/definitions/AnswersOptions" - } - } - }, - "AnalyzeConversationResult": { - "type": "object", - "description": "Represents a conversation analysis response.", - "required": [ - "query", - "prediction" - ], - "properties": { - "query": { - "type": "string", - "description": "The conversation utterance given by the caller." - }, - "detectedLanguage": { - "type": "string", - "description": "The system detected language for the query in BCP 47 language representation.." - }, - "prediction": { - "description": "The prediction result of a conversation project.", - "$ref": "#/definitions/BasePrediction" - } - } - }, - "BasePrediction": { - "type": "object", - "description": "This is the base class of prediction", - "required": [ - "projectKind" - ], - "discriminator": "projectKind", - "properties": { - "projectKind": { - "type": "string", - "description": "The type of the project.", - "enum": [ - "Conversation", - "Orchestration" - ], - "x-ms-enum": { - "name": "projectKind", - "modelAsString": true - } - }, - "topIntent": { - "type": "string", - "description": "The intent with the highest score." - } - } - }, - "OrchestrationPrediction": { - "type": "object", - "description": "This represents the prediction result of an Orchestration project.", - "x-ms-discriminator-value": "Orchestration", - "required": [ - "intents" - ], - "allOf": [ - { - "$ref": "#/definitions/BasePrediction" - } - ], - "properties": { - "intents": { - "description": "A dictionary that contains all intents. A key is an intent name and a value is its confidence score and target type. The top intent's value also contains the actual response from the target project.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TargetIntentResult" - } - } - } - }, - "TargetIntentResult": { - "type": "object", - "description": "This is the base class of an intent prediction", - "discriminator": "targetProjectKind", - "required": [ - "confidenceScore", - "targetProjectKind" - ], - "properties": { - "targetProjectKind": { - "type": "string", - "description": "This discriminator property specifies the type of the target project that returns the response.", - "enum": [ - "Luis", - "Conversation", - "QuestionAnswering", - "NonLinked" - ], - "x-ms-enum": { - "name": "targetProjectKind", - "modelAsString": true - } - }, - "apiVersion": { - "type": "string", - "description": "The API version used to call a target service." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidence", - "description": "The prediction score and it ranges from 0.0 to 1.0.", - "minimum": 0, - "maximum": 1 - } - } - }, - "ConversationTargetIntentResult": { - "type": "object", - "description": "A wrap up of Conversation project response.", - "x-ms-discriminator-value": "Conversation", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "type": "object", - "$ref": "#/definitions/ConversationResult", - "description": "The actual response from a Conversation project." - } - } - }, - "ConversationResult": { - "type": "object", - "description": "The response returned by a Conversation project.", - "required": [ - "query" - ], - "properties": { - "query": { - "description": "The same query given in request.", - "type": "string" - }, - "detectedLanguage": { - "description": "The detected language from the query in BCP 47 language representation..", - "type": "string" - }, - "prediction": { - "description": "The predicted result for the query.", - "$ref": "#/definitions/ConversationPrediction" - } - } - }, - "ConversationPrediction": { - "type": "object", - "description": "Represents the prediction section of a Conversation project.", - "x-ms-discriminator-value": "Conversation", - "required": [ - "intents", - "entities" - ], - "allOf": [ - { - "$ref": "#/definitions/BasePrediction" - } - ], - "properties": { - "intents": { - "description": "The intent classification results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationIntent" - } - }, - "entities": { - "description": "The entity extraction results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationEntity" - } - } - } - }, - "ConversationIntent": { - "type": "object", - "description": "The intent classification result of a Conversation project.", - "required": [ - "category", - "confidenceScore" - ], - "properties": { - "category": { - "description": "A predicted class.", - "type": "string" - }, - "confidenceScore": { - "format": "float", - "x-ms-client-name": "confidence", - "description": "The confidence score of the class from 0.0 to 1.0.", - "type": "number", - "minimum": 0, - "maximum": 1 - } - } - }, - "ConversationEntity": { - "type": "object", - "description": "The entity extraction result of a Conversation project.", - "required": [ - "category", - "text", - "offset", - "length", - "confidenceScore" - ], - "properties": { - "category": { - "description": "The entity category.", - "type": "string" - }, - "text": { - "description": "The predicted entity text.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "The starting index of this entity in the query.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "The length of the text.", - "type": "integer" - }, - "confidenceScore": { - "format": "float", - "x-ms-client-name": "confidence", - "description": "The entity confidence score.", - "type": "number" - }, - "resolutions": { - "description": "The collection of entity resolution objects.", - "type": "array", - "items": { - "$ref": "#/definitions/BaseResolution" - } - }, - "extraInformation": { - "description": "The collection of entity extra information objects.", - "type": "array", - "items": { - "$ref": "#/definitions/BaseExtraInformation" - } - } - } - }, - "BaseExtraInformation": { - "description": "The abstract base object for entity extra information.", - "type": "object", - "discriminator": "extraInformationKind", - "properties": { - "extraInformationKind": { - "description": "The extra information object kind.", - "type": "string", - "enum": [ - "EntitySubtype", - "ListKey" - ], - "x-ms-enum": { - "name": "ExtraInformationKind", - "modelAsString": true - } - } - }, - "required": [ - "extraInformationKind" - ] - }, - "EntitySubtype": { - "description": "The concrete entity Subtype model of extra information.", - "allOf": [ - { - "$ref": "#/definitions/BaseExtraInformation" - } - ], - "type": "object", - "x-ms-discriminator-value": "EntitySubtype", - "properties": { - "value": { - "type": "string", - "description": "The Subtype of an extracted entity type." - } - } - }, - "ListKey": { - "description": "The list key extra data kind.", - "allOf": [ - { - "$ref": "#/definitions/BaseExtraInformation" - } - ], - "type": "object", - "x-ms-discriminator-value": "ListKey", - "properties": { - "key": { - "type": "string", - "description": "The canonical form of the extracted entity." - } - } - }, - "BaseResolution": { - "description": "The abstract base class for entity resolutions.", - "type": "object", - "discriminator": "resolutionKind", - "properties": { - "resolutionKind": { - "description": "The entity resolution object kind.", - "type": "string", - "enum": [ - "BooleanResolution", - "DateTimeResolution", - "NumberResolution", - "OrdinalResolution", - "SpeedResolution", - "WeightResolution", - "LengthResolution", - "VolumeResolution", - "AreaResolution", - "AgeResolution", - "InformationResolution", - "TemperatureResolution", - "CurrencyResolution", - "NumericRangeResolution", - "TemporalSpanResolution" - ], - "x-ms-enum": { - "name": "ResolutionKind", - "modelAsString": true - } - } - }, - "required": [ - "resolutionKind" - ] - }, - "QuantityResolution": { - "description": "Represents resolutions for quantities.", - "type": "object", - "properties": { - "value": { - "type": "number", - "format": "double", - "description": "The numeric value that the extracted text denotes." - } - }, - "required": [ - "value" - ] - }, - "AgeResolution": { - "description": "Represents the Age entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "AgeResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Year", - "Month", - "Week", - "Day" - ], - "x-ms-enum": { - "name": "AgeUnit", - "modelAsString": true - }, - "description": "The Age Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "VolumeResolution": { - "description": "Represents the volume entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "VolumeResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "CubicMeter", - "CubicCentimeter", - "CubicMillimeter", - "Hectoliter", - "Decaliter", - "Liter", - "Centiliter", - "Milliliter", - "CubicYard", - "CubicInch", - "CubicFoot", - "CubicMile", - "FluidOunce", - "Teaspoon", - "Tablespoon", - "Pint", - "Quart", - "Cup", - "Gill", - "Pinch", - "FluidDram", - "Barrel", - "Minim", - "Cord", - "Peck", - "Bushel", - "Hogshead" - ], - "x-ms-enum": { - "name": "VolumeUnit", - "modelAsString": true - }, - "description": "The Volume Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "SpeedResolution": { - "description": "Represents the speed entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "SpeedResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "MetersPerSecond", - "KilometersPerHour", - "KilometersPerMinute", - "KilometersPerSecond", - "MilesPerHour", - "Knot", - "FootPerSecond", - "FootPerMinute", - "YardsPerMinute", - "YardsPerSecond", - "MetersPerMillisecond", - "CentimetersPerMillisecond", - "KilometersPerMillisecond" - ], - "x-ms-enum": { - "name": "SpeedUnit", - "modelAsString": true - }, - "description": "The speed Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "AreaResolution": { - "description": "Represents the area entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "AreaResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "SquareKilometer", - "SquareHectometer", - "SquareDecameter", - "SquareDecimeter", - "SquareMeter", - "SquareCentimeter", - "SquareMillimeter", - "SquareInch", - "SquareFoot", - "SquareMile", - "SquareYard", - "Acre" - ], - "x-ms-enum": { - "name": "AreaUnit", - "modelAsString": true - }, - "description": "The area Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "LengthResolution": { - "description": "Represents the length entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "LengthResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Kilometer", - "Hectometer", - "Decameter", - "Meter", - "Decimeter", - "Centimeter", - "Millimeter", - "Micrometer", - "Nanometer", - "Picometer", - "Mile", - "Yard", - "Inch", - "Foot", - "LightYear", - "Pt" - ], - "x-ms-enum": { - "name": "LengthUnit", - "modelAsString": true - }, - "description": "The length Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "InformationResolution": { - "description": "Represents the information (data) entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "InformationResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Bit", - "Kilobit", - "Megabit", - "Gigabit", - "Terabit", - "Petabit", - "Byte", - "Kilobyte", - "Megabyte", - "Gigabyte", - "Terabyte", - "Petabyte" - ], - "x-ms-enum": { - "name": "InformationUnit", - "modelAsString": true - }, - "description": "The information (data) Unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "TemperatureResolution": { - "description": "Represents the temperature entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "TemperatureResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Fahrenheit", - "Kelvin", - "Rankine", - "Celsius" - ], - "x-ms-enum": { - "name": "TemperatureUnit", - "modelAsString": true - }, - "description": "The temperature Unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "WeightResolution": { - "description": "Represents the weight entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "WeightResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Kilogram", - "Gram", - "Milligram", - "Gallon", - "MetricTon", - "Ton", - "Pound", - "Ounce", - "Grain", - "PennyWeight", - "LongTonBritish", - "ShortTonUS", - "ShortHundredWeightUS", - "Stone", - "Dram" - ], - "x-ms-enum": { - "name": "WeightUnit", - "modelAsString": true - }, - "description": "The weight Unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "CurrencyResolution": { - "description": "Represents the currency entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "CurrencyResolution", - "properties": { - "ISO4217": { - "type": "string", - "description": "The alphabetic code based on another ISO standard, ISO 3166, which lists the codes for country names. The first two letters of the ISO 4217 three-letter code are the same as the code for the country name, and, where possible, the third letter corresponds to the first letter of the currency name." - }, - "value": { - "type": "number", - "format": "double", - "description": "The money amount captured in the extracted entity" - }, - "unit": { - "type": "string", - "description": "The unit of the amount captured in the extracted entity" - } - }, - "required": [ - "value", - "unit" - ] - }, - "BooleanResolution": { - "description": "A resolution for boolean expressions", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "BooleanResolution", - "properties": { - "value": { - "type": "boolean" - } - }, - "required": [ - "value" - ] - }, - "DateTimeResolution": { - "description": "A resolution for datetime entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "DateTimeResolution", - "properties": { - "timex": { - "$ref": "#/definitions/TimeExpression" - }, - "dateTimeSubKind": { - "type": "string", - "enum": [ - "Time", - "Date", - "DateTime", - "Duration", - "Set" - ], - "x-ms-enum": { - "name": "DateTimeSubKind", - "modelAsString": true - }, - "description": "The DateTime SubKind" - }, - "value": { - "type": "string", - "description": "The actual time that the extracted text denote." - }, - "modifier": { - "$ref": "#/definitions/TemporalModifier" - } - }, - "required": [ - "timex", - "dateTimeSubKind", - "value" - ] - }, - "NumberResolution": { - "description": "A resolution for numeric entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "NumberResolution", - "properties": { - "numberKind": { - "type": "string", - "enum": [ - "Integer", - "Decimal", - "Power", - "Fraction", - "Percent", - "Unspecified" - ], - "x-ms-enum": { - "name": "NumberKind", - "modelAsString": true - }, - "description": "The type of the extracted number entity." - }, - "value": { - "type": "string", - "description": "A numeric representation of what the extracted text denotes." - } - }, - "required": [ - "numberKind", - "value" - ] - }, - "OrdinalResolution": { - "description": "A resolution for ordinal numbers entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "OrdinalResolution", - "properties": { - "offset": { - "type": "string", - "description": "The offset With respect to the reference (e.g., offset = -1 in \"show me the second to last\"" - }, - "relativeTo": { - "type": "string", - "enum": [ - "Current", - "End", - "Start" - ], - "x-ms-enum": { - "name": "RelativeTo", - "modelAsString": true - }, - "description": "The reference point that the ordinal number denotes." - }, - "value": { - "type": "string", - "description": "A simple arithmetic expression that the ordinal denotes." - } - }, - "required": [ - "offset", - "relativeTo", - "value" - ] - }, - "TemporalSpanResolution": { - "description": "represents the resolution of a date and/or time span.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "TemporalSpanResolution", - "properties": { - "begin": { - "$ref": "#/definitions/TimeExpression" - }, - "end": { - "$ref": "#/definitions/TimeExpression" - }, - "duration": { - "type": "string", - "description": "An optional duration value formatted based on the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)" - }, - "modifier": { - "$ref": "#/definitions/TemporalModifier" - } - } - }, - "NumericRangeResolution": { - "description": "represents the resolution of numeric intervals.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "NumericRangeResolution", - "properties": { - "rangeKind": { - "type": "string", - "enum": [ - "Number", - "Speed", - "Weight", - "Length", - "Volume", - "Area", - "Age", - "Information", - "Temperature", - "Currency" - ], - "x-ms-enum": { - "name": "RangeKind", - "modelAsString": true - }, - "description": "The kind of range that the resolution object represents." - }, - "minimum": { - "type": "number", - "format": "double", - "description": "The beginning value of the interval." - }, - "maximum": { - "type": "number", - "format": "double", - "description": "The ending value of the interval." - } - }, - "required": [ - "rangeKind", - "minimum", - "maximum" - ] - }, - "TemporalModifier": { - "type": "string", - "description": "An optional modifier of a date/time instance.", - "enum": [ - "AfterApprox", - "Before", - "BeforeStart", - "Approx", - "ReferenceUndefined", - "SinceEnd", - "AfterMid", - "Start", - "After", - "BeforeEnd", - "Until", - "End", - "Less", - "Since", - "AfterStart", - "BeforeApprox", - "Mid", - "More" - ], - "x-ms-enum": { - "name": "TemporalModifier", - "modelAsString": true - } - }, - "TimeExpression": { - "type": "string", - "description": "An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)" - }, - "LuisTargetIntentResult": { - "type": "object", - "description": "It is a wrap up of LUIS Generally Available response.", - "x-ms-discriminator-value": "Luis", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "type": "object", - "description": "The actual response from a LUIS Generally Available application." - } - } - }, - "QuestionAnsweringTargetIntentResult": { - "type": "object", - "description": "It is a wrap up a Question Answering KB response.", - "x-ms-discriminator-value": "QuestionAnswering", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "description": "The generated answer by a Question Answering KB.", - "$ref": "common.json#/definitions/AnswersResult" - } - } - }, - "AnalyzeConversationJobsInput": { - "properties": { - "displayName": { - "description": "Optional display name for the analysis job.", - "type": "string" - }, - "analysisInput": { - "$ref": "#/definitions/MultiLanguageConversationAnalysisInput" - }, - "tasks": { - "description": "The set of tasks to execute on the input conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeConversationLROTask" - } - } - }, - "required": [ - "analysisInput", - "tasks" - ] - }, - "AnalyzeConversationLROTask": { - "description": "The base class for an long running conversation input task.", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationLROTaskKind" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskIdentifier" - } - ] - }, - "AnalyzeConversationLROTaskKind": { - "type": "string", - "description": "Enumeration of supported analysis tasks on a collection of conversations.", - "enum": [ - "ConversationalPIITask", - "ConversationalSummarizationTask" - ], - "x-ms-enum": { - "name": "AnalyzeConversationLROTaskKind", - "modelAsString": true - } - }, - "AnalyzeConversationResultsKind": { - "type": "string", - "description": "Enumeration of supported Conversation Analysis task results.", - "enum": [ - "ConversationalPIIResults", - "ConversationalSummarizationResults" - ], - "x-ms-enum": { - "name": "AnalyzeConversationResultsKind", - "modelAsString": true - } - }, - "AnalyzeConversationPIITask": { - "type": "object", - "description": "Task definition for a PII redaction in conversations.", - "properties": { - "parameters": { - "$ref": "#/definitions/ConversationPIITaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationLROTask" - } - ], - "x-ms-discriminator-value": "ConversationalPIITask" - }, - "ConversationPIIItemResult": { - "type": "object", - "required": [ - "id", - "redactedContent", - "entities" - ], - "properties": { - "id": { - "type": "string" - }, - "redactedContent": { - "type": "object", - "$ref": "#/definitions/RedactedTranscriptContent" - }, - "entities": { - "type": "array", - "items": { - "$ref": "#/definitions/Entity" - } - } - } - }, - "MultiLanguageConversationAnalysisInput": { - "required": [ - "conversations" - ], - "properties": { - "conversations": { - "type": "array", - "items": { - "$ref": "#/definitions/Conversation" - } - } - } - }, - "Conversation": { - "type": "object", - "description": "A complete ordered set of utterances (spoken or written), by one or more speakers to be used for analysis.", - "discriminator": "modality", - "required": [ - "id", - "language", - "modality" - ], - "properties": { - "id": { - "description": "Unique identifier for the conversation.", - "type": "string" - }, - "language": { - "description": "The language of the conversation item in BCP-47 format.", - "type": "string" - }, - "modality": { - "$ref": "#/definitions/Modality" - }, - "domain": { - "$ref": "#/definitions/ConversationDomain" - } - } - }, - "Modality": { - "type": "string", - "description": "Enumeration of supported conversational modalities.", - "enum": [ - "transcript", - "text" - ], - "x-ms-enum": { - "name": "InputModality", - "modelAsString": true - } - }, - "ConversationDomain": { - "type": "string", - "description": "Enumeration of supported conversational domains.", - "enum": [ - "finance", - "healthcare", - "generic" - ], - "x-ms-enum": { - "name": "ConversationDomain", - "modelAsString": true - } - }, - "TextConversation": { - "x-ms-discriminator-value": "text", - "required": [ - "conversationItems" - ], - "allOf": [ - { - "$ref": "#/definitions/Conversation" - } - ], - "properties": { - "conversationItems": { - "description": "Ordered list of text conversation items in the conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/TextConversationItem" - } - } - } - }, - "TranscriptConversation": { - "x-ms-discriminator-value": "transcript", - "required": [ - "conversationItems" - ], - "allOf": [ - { - "$ref": "#/definitions/Conversation" - } - ], - "properties": { - "conversationItems": { - "description": "Ordered list of transcript conversation items in the conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/TranscriptConversationItem" - } - } - } - }, - "TranscriptConversationItem": { - "type": "object", - "description": "Additional properties for supporting transcript conversation.", - "allOf": [ - { - "$ref": "#/definitions/ConversationItemBase" - } - ], - "properties": { - "itn": { - "type": "string", - "description": "Inverse Text Normalization representation of input. The inverse-text-normalized form is the recognized text from Microsoft’s Speech to Text API, with phone numbers, numbers, abbreviations, and other transformations applied." - }, - "maskedItn": { - "type": "string", - "description": "The Inverse Text Normalized format with profanity masking applied." - }, - "text": { - "type": "string", - "description": "The display form of the recognized text from speech to text API, with punctuation and capitalization added." - }, - "lexical": { - "type": "string", - "description": "The lexical form of the recognized text from speech to text API with the actual words recognized." - }, - "audioTimings": { - "type": "array", - "description": "The list of word level audio timing information", - "items": { - "$ref": "#/definitions/WordLevelTiming" - } - } - } - }, - "RedactedTranscriptContent": { - "type": "object", - "description": "The transcript content response generated by the service with all necessary personally identifiable information redacted.", - "properties": { - "itn": { - "type": "string", - "description": "The redacted output for inverse text normalized format input." - }, - "maskedItn": { - "type": "string", - "description": "The redacted output for masked inverse text normalized format input." - }, - "text": { - "type": "string", - "description": "The redacted output for text (Microsoft's Speech to Text 'display') format input." - }, - "lexical": { - "type": "string", - "description": "The redacted output for lexical format input." - }, - "audioTimings": { - "type": "array", - "description": "The list of redacted audio segments.", - "items": { - "$ref": "#/definitions/AudioTiming" - } - } - } - }, - "WordLevelTiming": { - "type": "object", - "description": "Word level timing information generated by the speech to text API. The words in this object should have 1:1 correspondence with the 'lexical' input to allow for audio redaction.", - "properties": { - "word": { - "type": "string", - "description": "The word recognized." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AudioTiming" - } - ] - }, - "AudioTiming": { - "type": "object", - "description": "The audio timing information.", - "properties": { - "offset": { - "description": "Offset from start of speech audio, in ticks. 1 tick = 100 ns.", - "type": "integer", - "format": "int64" - }, - "duration": { - "description": "Duration of word articulation, in ticks. 1 tick = 100 ns.", - "type": "integer", - "format": "int64" - } - } - }, - "Entity": { - "type": "object", - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ], - "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "type": "string", - "description": "Entity type." - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub type." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted entity." - } - } - }, - "AnalyzeConversationConversationPIIResult": { - "type": "object", - "description": "Result from the personally identifiable information detection and redaction operation performed on a list of conversations.", - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationJobResult" - } - ], - "properties": { - "results": { - "$ref": "#/definitions/ConversationPIIResults" - } - }, - "required": [ - "results" - ], - "x-ms-discriminator-value": "ConversationalPIIResults" - }, - "ConversationPIIResults": { - "type": "object", - "description": "The result from PII detection and redaction operation for each conversation.", - "required": [ - "conversations" - ], - "properties": { - "conversations": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "#/definitions/ConversationPIIResult" - }, - { - "$ref": "#/definitions/ConversationResultBase" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ] - }, - "ConversationPIIResult": { - "description": "The result from PII detection and redaction operation for each conversation.", - "required": [ - "conversationItems" - ], - "properties": { - "conversationItems": { - "description": "Enumeration of PII detection and redaction operation results for all the conversation items in a conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationPIIItemResult" - } - } - } - }, - "ConversationPIITaskParameters": { - "type": "object", - "description": "Supported parameters for a Conversational PII detection and redaction task.", - "properties": { - "piiCategories": { - "$ref": "#/definitions/ConversationPIICategories" - }, - "includeAudioRedaction": { - "type": "boolean", - "description": "Flag to indicate if audio redaction is requested. By default audio redaction will not be performed.", - "default": false - }, - "redactionSource": { - "type": "string", - "description": "For transcript conversations, this parameter provides information regarding which content type (ITN, Text, Lexical, Masked ITN) should be used for entity detection. The details of the entities detected - like the offset, length and the text itself - will correspond to the text type selected here.", - "$ref": "#/definitions/TranscriptContentType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "ConversationPIICategories": { - "description": "Describes the PII categories to return for detection. If not provided, 'default' categories will be returned which will vary with the language.", - "items": { - "type": "string", - "x-ms-enum": { - "name": "ConversationPIICategory", - "modelAsString": true - }, - "enum": [ - "Address", - "CreditCard", - "Email", - "Name", - "NumericIdentifier", - "PhoneNumber", - "All", - "Default" - ] - }, - "type": "array", - "uniqueItems": true - }, - "TranscriptContentType": { - "type": "string", - "description": "Enumeration of supported transcript content types.", - "enum": [ - "lexical", - "itn", - "maskedItn", - "text" - ], - "x-ms-enum": { - "name": "TranscriptContentType", - "modelAsString": true - } - }, - "AnalyzeConversationSummarizationTask": { - "type": "object", - "description": "Task definition for conversational summarization.", - "properties": { - "parameters": { - "$ref": "#/definitions/ConversationSummarizationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationLROTask" - } - ], - "x-ms-discriminator-value": "ConversationalSummarizationTask" - }, - "ConversationSummarizationTaskParameters": { - "type": "object", - "description": "Supported parameters for an conversational summarization task.", - "required": [ - "summaryAspects" - ], - "properties": { - "summaryAspects": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "issue", - "resolution" - ], - "x-ms-enum": { - "name": "SummaryAspect", - "modelAsString": true - } - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "AnalyzeConversationSummarizationResult": { - "type": "object", - "description": "Result for the summarization task on the conversation.", - "properties": { - "results": { - "$ref": "#/definitions/SummaryResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationJobResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "ConversationalSummarizationResults" - }, - "SummaryResult": { - "type": "object", - "required": [ - "conversations" - ], - "properties": { - "conversations": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "#/definitions/ConversationsSummaryResult" - }, - { - "$ref": "#/definitions/ConversationResultBase" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ] - }, - "ConversationsSummaryResult": { - "type": "object", - "required": [ - "summaries" - ], - "properties": { - "summaries": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "#/definitions/SummaryResultItem" - } - ] - } - } - } - }, - "SummaryResultItem": { - "type": "object", - "properties": { - "aspect": { - "type": "string" - }, - "text": { - "type": "string" - } - }, - "required": [ - "aspect", - "text" - ] - }, - "AnalyzeConversationJobState": { - "description": "Contains the status of the analyze conversations job submitted along with related statistics.", - "allOf": [ - { - "$ref": "common.json#/definitions/JobState" - }, - { - "$ref": "#/definitions/ConversationTasksState" - }, - { - "$ref": "#/definitions/AnalyzeConversationJobStatistics" - } - ] - }, - "AnalyzeConversationJobStatistics": { - "description": "Contains the statistics for the job submitted.", - "properties": { - "statistics": { - "$ref": "#/definitions/ConversationRequestStatistics" - } - }, - "type": "object" - }, - "ConversationTasksState": { - "description": "Contains the state for the tasks being executed as part of the analyze conversation job submitted.", - "properties": { - "tasks": { - "properties": { - "completed": { - "description": "Count of tasks completed successfully.", - "type": "integer" - }, - "failed": { - "description": "Count of tasks that failed.", - "type": "integer" - }, - "inProgress": { - "description": "Count of tasks in progress currently.", - "type": "integer" - }, - "total": { - "description": "Total count of tasks submitted as part of the job.", - "type": "integer" - }, - "items": { - "description": "List of results from tasks (if available).", - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeConversationJobResult" - } - } - }, - "required": [ - "total", - "completed", - "failed", - "inProgress" - ], - "type": "object" - } - }, - "required": [ - "tasks" - ], - "type": "object" - }, - "AnalyzeConversationJobResult": { - "type": "object", - "description": "Container for results for all tasks in the conversation job.", - "discriminator": "kind", - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationResultsKind" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskState" - }, - { - "$ref": "common.json#/definitions/TaskIdentifier" - } - ], - "required": [ - "kind" - ] - }, - "ConversationResultBase": { - "type": "object", - "description": "Shared attributes for all conversational task results.", - "required": [ - "id", - "warnings" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique, non-empty conversation identifier." - }, - "warnings": { - "type": "array", - "description": "Warnings encountered while processing document.", - "items": { - "$ref": "common.json#/definitions/InputWarning" - } - }, - "statistics": { - "$ref": "#/definitions/ConversationStatistics" - } - } - }, - "ConversationStatistics": { - "type": "object", - "description": "If showStats=true was specified in the request this field will contain information about the conversation payload.", - "required": [ - "transactionsCount" - ], - "properties": { - "transactionsCount": { - "type": "integer", - "format": "int32", - "description": "Number of text units for the request." - } - } - }, - "ConversationRequestStatistics": { - "type": "object", - "description": "if showStats=true was specified in the request this field will contain information about the request payload.", - "required": [ - "conversationsCount", - "validConversationsCount", - "erroneousConversationsCount" - ], - "properties": { - "conversationsCount": { - "type": "integer", - "format": "int32", - "description": "Number of conversations submitted in the request." - }, - "validConversationsCount": { - "type": "integer", - "format": "int32", - "description": "Number of conversations documents. This excludes empty, over-size limit or non-supported languages documents." - }, - "erroneousConversationsCount": { - "type": "integer", - "format": "int32", - "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/RequestStatistics" - } - ] - } - }, - "parameters": { - "ConversationAnalysisOptions": { - "name": "ConversationAnalysisOptions", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationAnalysisOptions" - }, - "description": "Post body of the request.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/analyzetext-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/analyzetext-authoring.json deleted file mode 100644 index 9066c809c480..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/analyzetext-authoring.json +++ /dev/null @@ -1,2972 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Text Analysis Authoring", - "version": "2022-05-15-preview", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview." - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/authoring/analyze-text/projects": { - "get": { - "description": "Lists the existing projects.", - "operationId": "TextAnalysisAuthoring_ListProjects", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of projects.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectsMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Projects": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListProjects.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/{projectName}": { - "patch": { - "description": "Creates a new project or updates an existing one.", - "operationId": "TextAnalysisAuthoring_CreateProject", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The project parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringCreateProjectOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of the updated project, if it already exists.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" - } - }, - "201": { - "description": "The metadata of the created project.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Create Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulCreateProject.json" - } - } - }, - "get": { - "description": "Gets the details of a project.", - "operationId": "TextAnalysisAuthoring_GetProject", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of the project.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetProject.json" - } - } - }, - "delete": { - "description": "Deletes a project.", - "operationId": "TextAnalysisAuthoring_DeleteProject", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/:export": { - "post": { - "description": "Triggers a job to export a project's data.", - "operationId": "TextAnalysisAuthoring_Export", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringStringIndexTypeQueryParameter" - }, - { - "in": "query", - "name": "assetKind", - "description": "Kind of asset to export.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Export Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulExportProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/:import": { - "post": { - "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", - "operationId": "TextAnalysisAuthoring_Import", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The project data to import.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProject" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Import Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulImportProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/:train": { - "post": { - "description": "Triggers a training job for a project.", - "operationId": "TextAnalysisAuthoring_Train", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The training input parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Train Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulTrainProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments": { - "get": { - "description": "Lists the deployments belonging to a project.", - "operationId": "TextAnalysisAuthoring_ListDeployments", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all deployments.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployments" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Deployments": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListDeployments.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/:swap": { - "post": { - "description": "Swaps two existing deployments with each other.", - "operationId": "TextAnalysisAuthoring_SwapDeployments", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The job object to swap two deployments.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringSwapDeploymentsOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Swap Deployments": { - "$ref": "./examples/analyzetext-authoring/SuccessfulSwapDeployments.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}": { - "get": { - "description": "Gets the details of a deployment.", - "operationId": "TextAnalysisAuthoring_GetDeployment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The Deployment info.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployment" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Deployment": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetDeployment.json" - } - } - }, - "put": { - "description": "Creates a new deployment or replaces an existing one.", - "operationId": "TextAnalysisAuthoring_DeployProject", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The new deployment info.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringCreateDeploymentOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Deploy Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeployProject.json" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "description": "Deletes a project deployment.", - "operationId": "TextAnalysisAuthoring_DeleteDeployment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Deployment": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteDeployment.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing deployment job.", - "operationId": "TextAnalysisAuthoring_GetDeploymentStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The deployment job result.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringDeploymentJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Deployment Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing swap deployment job.", - "operationId": "TextAnalysisAuthoring_GetSwapDeploymentsStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The swap deployment job result.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringDeploymentJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Swap Deployments Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}": { - "get": { - "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", - "operationId": "TextAnalysisAuthoring_GetExportStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The status of the long running operation.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringExportProjectJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Export Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetExportStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}": { - "get": { - "description": "Gets the status for an import.", - "operationId": "TextAnalysisAuthoring_GetImportStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The details of the long running operation.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringImportProjectJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Import Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetImportStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models": { - "get": { - "description": "Lists the trained models belonging to a project.", - "operationId": "TextAnalysisAuthoring_ListTrainedModels", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all trained models.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModels" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Models": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListModels.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}": { - "get": { - "description": "Gets the details of a trained model.", - "operationId": "TextAnalysisAuthoring_GetTrainedModel", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Trained model info", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModel" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetModel.json" - } - } - }, - "delete": { - "description": "Deletes an existing trained model.", - "operationId": "TextAnalysisAuthoring_DeleteTrainedModel", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "204": { - "description": "Deleted successfully." - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Model": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteModel.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { - "get": { - "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", - "operationId": "TextAnalysisAuthoring_GetModelEvaluationResults", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringStringIndexTypeQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of the evaluation results.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationResults" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model Evaluation": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { - "get": { - "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", - "operationId": "TextAnalysisAuthoring_GetModelEvaluationSummary", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all evaluation results.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model Evaluation Summary": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/train/jobs": { - "get": { - "description": "Lists the non-expired training jobs created for a project.", - "operationId": "TextAnalysisAuthoring_ListTrainingJobs", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of the training jobs.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobs" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Training Jobs": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListTrainingJobs.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}": { - "get": { - "description": "Gets the status for a training job.", - "operationId": "TextAnalysisAuthoring_GetTrainingStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The training job result.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Train Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetTrainStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}/:cancel": { - "post": { - "description": "Triggers a cancellation for a running training job.", - "operationId": "TextAnalysisAuthoring_CancelTrainingJob", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the job cancellation.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Cancel Training Job": { - "$ref": "./examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/global/deletion-jobs/{jobId}": { - "get": { - "description": "Gets the status for a project deletion job.", - "operationId": "TextAnalysisAuthoring_GetProjectDeletionStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The project deletion job result.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectDeletionJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Project Deletion Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/global/languages": { - "get": { - "description": "Lists the supported languages.", - "operationId": "TextAnalysisAuthoring_GetSupportedLanguages", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of supported languages.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringSupportedLanguages" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Supported Languages": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/global/training-config-versions": { - "get": { - "description": "Lists the support training config version for a given project type.", - "operationId": "TextAnalysisAuthoring_ListTrainingConfigVersions", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/TextAnalysisAuthoringProjectKindQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all trained models.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingConfigVersions" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Supported Training Config Versions": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - } - }, - "definitions": { - "TextAnalysisAuthoringConfusionMatrix": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixRow" - }, - "x-ms-client-name": "ConfusionMatrix" - }, - "TextAnalysisAuthoringConfusionMatrixCell": { - "description": "Represents a cell in a confusion matrix.", - "required": [ - "normalizedValue", - "rawValue" - ], - "type": "object", - "properties": { - "normalizedValue": { - "format": "float", - "description": "Represents normalized value in percentages.", - "type": "number" - }, - "rawValue": { - "format": "float", - "description": "Represents raw value.", - "type": "number" - } - }, - "x-ms-client-name": "ConfusionMatrixCell" - }, - "TextAnalysisAuthoringConfusionMatrixRow": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixCell" - }, - "x-ms-client-name": "ConfusionMatrixRow" - }, - "TextAnalysisAuthoringCreateDeploymentOptions": { - "description": "Represents the options for creating or updating a project deployment.", - "required": [ - "trainedModelLabel" - ], - "type": "object", - "properties": { - "trainedModelLabel": { - "description": "Represents the trained model label.", - "type": "string" - } - }, - "x-ms-client-name": "CreateDeploymentOptions" - }, - "TextAnalysisAuthoringCreateProjectOptions": { - "description": "Represents the options used to create or update a project.", - "required": [ - "projectKind", - "storageInputContainerName", - "projectName", - "language" - ], - "type": "object", - "properties": { - "projectKind": { - "description": "The project kind.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" - }, - "storageInputContainerName": { - "description": "The storage container name.", - "type": "string" - }, - "settings": { - "description": "The project settings.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectSettings" - }, - "projectName": { - "description": "The new project name.", - "type": "string" - }, - "multilingual": { - "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" - }, - "description": { - "description": "The project description.", - "type": "string" - }, - "language": { - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "CreateProjectOptions" - }, - "TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult": { - "description": "Represents the document evaluation result for a custom entity recognition project.", - "required": [ - "customEntityRecognitionResult" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - ], - "properties": { - "customEntityRecognitionResult": { - "description": "Represents the evaluation prediction for entity recognition.", - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult" - } - }, - "x-ms-discriminator-value": "CustomEntityRecognition", - "x-ms-client-name": "CustomEntityRecognitionDocumentEvaluationResult" - }, - "TextAnalysisAuthoringCustomEntityRecognitionEvaluationSummary": { - "description": "Represents the evaluation summary for a custom entity recognition project.", - "required": [ - "customEntityRecognitionEvaluation" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - ], - "properties": { - "customEntityRecognitionEvaluation": { - "description": "Contains the data related to extraction evaluation.", - "$ref": "#/definitions/TextAnalysisAuthoringEntityRecognitionEvaluationSummary" - } - }, - "x-ms-discriminator-value": "CustomEntityRecognition", - "x-ms-client-name": "CustomEntityRecognitionEvaluationSummary" - }, - "TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult": { - "description": "Represents the document evaluation result for a custom multi-label classification project.", - "required": [ - "customMultiLabelClassificationResult" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - ], - "properties": { - "customMultiLabelClassificationResult": { - "description": "Represents the evaluation prediction for multi label classification.", - "$ref": "#/definitions/TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult" - } - }, - "x-ms-discriminator-value": "CustomMultiLabelClassification", - "x-ms-client-name": "CustomMultiLabelClassificationDocumentEvaluationResult" - }, - "TextAnalysisAuthoringCustomMultiLabelClassificationEvaluationSummary": { - "description": "Represents the evaluation summary for a custom multi-label classification project.", - "required": [ - "customMultiLabelClassificationEvaluation" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - ], - "properties": { - "customMultiLabelClassificationEvaluation": { - "description": "Contains the data related to multi label classification evaluation.", - "$ref": "#/definitions/TextAnalysisAuthoringMultiLabelClassificationEvaluationSummary" - } - }, - "x-ms-discriminator-value": "CustomMultiLabelClassification", - "x-ms-client-name": "CustomMultiLabelClassificationEvaluationSummary" - }, - "TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult": { - "description": "Represents the document evaluation result for a custom single-label classification project.", - "required": [ - "customSingleLabelClassificationResult" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - ], - "properties": { - "customSingleLabelClassificationResult": { - "description": "Represents the evaluation prediction for single label classification.", - "$ref": "#/definitions/TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult" - } - }, - "x-ms-discriminator-value": "CustomSingleLabelClassification", - "x-ms-client-name": "CustomSingleLabelClassificationDocumentEvaluationResult" - }, - "TextAnalysisAuthoringCustomSingleLabelClassificationEvaluationSummary": { - "description": "Represents the evaluation summary for a custom single-label classification project.", - "required": [ - "customSingleLabelClassificationEvaluation" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - ], - "properties": { - "customSingleLabelClassificationEvaluation": { - "description": "Contains the data related to single label classification evaluation.", - "$ref": "#/definitions/TextAnalysisAuthoringSingleLabelClassificationEvaluationSummary" - } - }, - "x-ms-discriminator-value": "CustomSingleLabelClassification", - "x-ms-client-name": "CustomSingleLabelClassificationEvaluationSummary" - }, - "TextAnalysisAuthoringDeploymentJobState": { - "description": "Represents the state of a deployment job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "DeploymentJobState" - }, - "TextAnalysisAuthoringDocumentEntityLabelEvaluationResult": { - "description": "Represents an evaluation result entity label.", - "required": [ - "category", - "offset", - "length" - ], - "type": "object", - "properties": { - "category": { - "description": "Represents the entity category.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "Represents the entity offset index relative to the original text.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "Represents the entity length.", - "type": "integer" - } - }, - "x-ms-client-name": "DocumentEntityLabelEvaluationResult" - }, - "TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult": { - "description": "Represents the entity recognition evaluation result for a document.", - "required": [ - "entities" - ], - "type": "object", - "properties": { - "entities": { - "description": "Represents the document labelled entities.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityRegionEvaluationResult" - } - } - }, - "x-ms-client-name": "DocumentEntityRecognitionEvaluationResult" - }, - "TextAnalysisAuthoringDocumentEntityRegionEvaluationResult": { - "description": "Represents the evaluation comparison between the expected and predicted entities of a document region.", - "required": [ - "expectedEntities", - "predictedEntities", - "regionOffset", - "regionLength" - ], - "type": "object", - "properties": { - "expectedEntities": { - "description": "Represents the region's expected entity labels.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityLabelEvaluationResult" - } - }, - "predictedEntities": { - "description": "Represents the region's predicted entity labels.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityLabelEvaluationResult" - } - }, - "regionOffset": { - "format": "int32", - "description": "Represents the region offset.", - "type": "integer" - }, - "regionLength": { - "format": "int32", - "description": "Represents the region length.", - "type": "integer" - } - }, - "x-ms-client-name": "DocumentEntityRegionEvaluationResult" - }, - "TextAnalysisAuthoringDocumentEvaluationResult": { - "description": "Represents the evaluation result of a document.", - "required": [ - "location", - "language", - "projectKind" - ], - "type": "object", - "properties": { - "location": { - "description": "Represents the document path.", - "type": "string" - }, - "language": { - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "projectKind": { - "description": "Represents the project kind.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" - } - }, - "discriminator": "projectKind", - "x-ms-client-name": "DocumentEvaluationResult" - }, - "TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult": { - "description": "Represents the comparison between the expected and predicted classes that are result from the evaluation operation.", - "required": [ - "expectedClasses", - "predictedClasses" - ], - "type": "object", - "properties": { - "expectedClasses": { - "description": "Represents the document's expected classes.", - "type": "array", - "items": { - "type": "string" - } - }, - "predictedClasses": { - "description": "Represents the document's predicted classes.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ms-client-name": "DocumentMultiLabelClassificationEvaluationResult" - }, - "TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult": { - "description": "Represents the comparison between the expected and predicted class that result from an evaluation operation.", - "required": [ - "expectedClass", - "predictedClass" - ], - "type": "object", - "properties": { - "expectedClass": { - "description": "Represents the document's expected class.", - "type": "string" - }, - "predictedClass": { - "description": "Represents the document's predicted class.", - "type": "string" - } - }, - "x-ms-client-name": "DocumentSingleLabelClassificationEvaluationResult" - }, - "TextAnalysisAuthoringEntityEvaluationSummary": { - "description": "Represents the evaluation summary for an entity.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], - "type": "object", - "properties": { - "f1": { - "format": "double", - "description": "Represents the model precision", - "type": "number" - }, - "precision": { - "format": "double", - "description": "Represents the model recall", - "type": "number" - }, - "recall": { - "format": "double", - "description": "Represents the model F1 score", - "type": "number" - }, - "truePositiveCount": { - "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" - }, - "trueNegativeCount": { - "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" - }, - "falsePositiveCount": { - "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" - }, - "falseNegativeCount": { - "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" - } - }, - "x-ms-client-name": "EntityEvaluationSummary" - }, - "TextAnalysisAuthoringEntityRecognitionEvaluationSummary": { - "description": "Represents the evaluation summary for a custom entity recognition project.", - "required": [ - "confusionMatrix", - "entities", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], - "type": "object", - "properties": { - "confusionMatrix": { - "description": "Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted.", - "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrix" - }, - "entities": { - "description": "Represents the entities evaluation", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringEntityEvaluationSummary" - } - }, - "microF1": { - "format": "float", - "description": "Represents the micro F1", - "type": "number" - }, - "microPrecision": { - "format": "float", - "description": "Represents the micro precision", - "type": "number" - }, - "microRecall": { - "format": "float", - "description": "Represents the micro recall", - "type": "number" - }, - "macroF1": { - "format": "float", - "description": "Represents the macro F1", - "type": "number" - }, - "macroPrecision": { - "format": "float", - "description": "Represents the macro precision", - "type": "number" - }, - "macroRecall": { - "format": "float", - "description": "Represents the macro recall", - "type": "number" - } - }, - "x-ms-client-name": "EntityRecognitionEvaluationSummary" - }, - "TextAnalysisAuthoringEvaluationKind": { - "enum": [ - "percentage", - "manual" - ], - "type": "string", - "x-ms-enum": { - "name": "EvaluationKind", - "modelAsString": true, - "values": [ - { - "value": "percentage", - "description": "Split the data into training and test sets according to user-defined percentages." - }, - { - "value": "manual", - "description": "Split the data according to the chosen dataset for every example in the data." - } - ] - }, - "x-ms-client-name": "EvaluationKind" - }, - "TextAnalysisAuthoringEvaluationOptions": { - "description": "Represents the options used running the evaluation.", - "type": "object", - "properties": { - "kind": { - "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationKind" - }, - "trainingSplitPercentage": { - "format": "int32", - "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" - }, - "testingSplitPercentage": { - "format": "int32", - "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" - } - }, - "x-ms-client-name": "EvaluationOptions" - }, - "TextAnalysisAuthoringEvaluationResults": { - "description": "Represents a list of results for an evaluation operation.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "THe list of documents evaluation results.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "EvaluationResults" - }, - "TextAnalysisAuthoringEvaluationSummary": { - "description": "Represents the summary for an evaluation operation.", - "required": [ - "projectKind", - "evaluationOptions" - ], - "type": "object", - "properties": { - "projectKind": { - "description": "Represents the project type that the evaluation ran on.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" - }, - "evaluationOptions": { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions" - } - }, - "discriminator": "projectKind", - "x-ms-client-name": "EvaluationSummary" - }, - "TextAnalysisAuthoringExportedClass": { - "description": "Represents a class of an exported project.", - "type": "object", - "properties": { - "category": { - "description": "The class category.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedClass" - }, - "TextAnalysisAuthoringExportedCustomEntityRecognitionDocument": { - "description": "Represents an exported document for a custom entity recognition project.", - "type": "object", - "properties": { - "entities": { - "description": "The list of entity labels belonging to the document.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentRegion" - } - }, - "location": { - "description": "The location of the document in the storage.", - "type": "string" - }, - "language": { - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedCustomEntityRecognitionDocument" - }, - "TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets": { - "description": "Represents the exported assets for a entity recognition project.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - ], - "properties": { - "entities": { - "description": "The list of entities belonging to the project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedEntity" - } - }, - "documents": { - "description": "The list of documents belonging to the project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomEntityRecognitionDocument" - } - } - }, - "x-ms-discriminator-value": "CustomEntityRecognition", - "x-ms-client-name": "ExportedCustomEntityRecognitionProjectAssets" - }, - "TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument": { - "description": "Represents an exported document of a custom multi-label classification project.", - "type": "object", - "properties": { - "classes": { - "description": "The document classes.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentClass" - } - }, - "location": { - "description": "The location of the document in the storage.", - "type": "string" - }, - "language": { - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedCustomMultiLabelClassificationDocument" - }, - "TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets": { - "description": "Represents the exported assets for a custom multi-label classification project.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - ], - "properties": { - "classes": { - "description": "The list of classes in the project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedClass" - } - }, - "documents": { - "description": "The list of documents in the project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument" - } - } - }, - "x-ms-discriminator-value": "CustomMultiLabelClassification", - "x-ms-client-name": "ExportedCustomMultiLabelClassificationProjectAssets" - }, - "TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument": { - "description": "Represents an exported document for a custom single-label classification project.", - "type": "object", - "properties": { - "class": { - "description": "The class of the documents.", - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentClass" - }, - "location": { - "description": "The location of the document in the storage.", - "type": "string" - }, - "language": { - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedCustomSingleLabelClassificationDocument" - }, - "TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets": { - "description": "Represents the exported assets for a single-label classification project.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - ], - "properties": { - "classes": { - "description": "The list of classes belonging to this project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedClass" - } - }, - "documents": { - "description": "The list of documents belonging to this project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument" - } - } - }, - "x-ms-discriminator-value": "CustomSingleLabelClassification", - "x-ms-client-name": "ExportedCustomSingleLabelClassificationProjectAssets" - }, - "TextAnalysisAuthoringExportedDocumentClass": { - "description": "Represents a classification label for a document.", - "type": "object", - "properties": { - "category": { - "type": "string" - } - }, - "x-ms-client-name": "ExportedDocumentClass" - }, - "TextAnalysisAuthoringExportedDocumentEntityLabel": { - "description": "Represents an entity label for a document.", - "type": "object", - "properties": { - "category": { - "description": "The entity category.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "Start position for the entity text.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "Length for the entity text.", - "type": "integer" - } - }, - "x-ms-client-name": "ExportedDocumentEntityLabel" - }, - "TextAnalysisAuthoringExportedDocumentRegion": { - "description": "Represents a region in a document for entity labeling.", - "type": "object", - "properties": { - "regionOffset": { - "format": "int32", - "description": "Start position for the region.", - "type": "integer" - }, - "regionLength": { - "format": "int32", - "description": "Length for the region text.", - "type": "integer" - }, - "labels": { - "description": "The list of entity labels belonging to this region.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentEntityLabel" - } - } - }, - "x-ms-client-name": "ExportedDocumentRegion" - }, - "TextAnalysisAuthoringExportedEntity": { - "description": "Represents an entity in an exported project.", - "type": "object", - "properties": { - "category": { - "description": "The entity category.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedEntity" - }, - "TextAnalysisAuthoringExportedProject": { - "description": "Represents an exported project.", - "required": [ - "projectFileVersion", - "stringIndexType", - "metadata" - ], - "type": "object", - "properties": { - "projectFileVersion": { - "description": "The version of the exported file.", - "type": "string" - }, - "stringIndexType": { - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "$ref": "#/definitions/TextAnalysisAuthoringStringIndexType" - }, - "metadata": { - "description": "Represents the project metadata.", - "$ref": "#/definitions/TextAnalysisAuthoringCreateProjectOptions" - }, - "assets": { - "description": "Represents the project assets.", - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - }, - "x-ms-client-name": "ExportedProject" - }, - "TextAnalysisAuthoringExportedProjectAssets": { - "description": "Represents the assets of an exported project.", - "required": [ - "projectKind" - ], - "type": "object", - "properties": { - "projectKind": { - "description": "The type of the project the assets belong to.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" - } - }, - "discriminator": "projectKind", - "x-ms-client-name": "ExportedProjectAssets" - }, - "TextAnalysisAuthoringExportProjectJobState": { - "description": "Represents the state of an export job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringJobState" - } - ], - "properties": { - "resultUrl": { - "description": "The URL to use in order to download the exported project.", - "type": "string" - } - }, - "x-ms-client-name": "ExportProjectJobState" - }, - "TextAnalysisAuthoringImportProjectJobState": { - "description": "Represents the state of an import job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "ImportProjectJobState" - }, - "TextAnalysisAuthoringJobState": { - "description": "Represents a job's state.", - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ], - "type": "object", - "properties": { - "jobId": { - "description": "The job ID.", - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "description": "The creation date time of the job.", - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "description": "The last date time the job was updated.", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "description": "The expiration date time of the job.", - "type": "string" - }, - "status": { - "description": "The job status.", - "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" - }, - "warnings": { - "description": "The warnings that were encountered while executing the job.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringWarning" - } - }, - "errors": { - "description": "The errors encountered while executing the job.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - } - }, - "x-ms-client-name": "JobState" - }, - "TextAnalysisAuthoringJobStatus": { - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling", - "partiallyCompleted" - ], - "type": "string", - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true - }, - "x-ms-client-name": "JobStatus" - }, - "TextAnalysisAuthoringMultiLabelClassEvaluationSummary": { - "description": "Represents the evaluation summary of a class in a multi-label classification project.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], - "type": "object", - "properties": { - "f1": { - "format": "double", - "description": "Represents the model precision", - "type": "number" - }, - "precision": { - "format": "double", - "description": "Represents the model recall", - "type": "number" - }, - "recall": { - "format": "double", - "description": "Represents the model F1 score", - "type": "number" - }, - "truePositiveCount": { - "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" - }, - "trueNegativeCount": { - "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" - }, - "falsePositiveCount": { - "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" - }, - "falseNegativeCount": { - "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" - } - }, - "x-ms-client-name": "MultiLabelClassEvaluationSummary" - }, - "TextAnalysisAuthoringMultiLabelClassificationEvaluationSummary": { - "description": "Represents the evaluation summary for a multi-label classification project.", - "required": [ - "classes", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], - "type": "object", - "properties": { - "classes": { - "description": "Represents the classes evaluation", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringMultiLabelClassEvaluationSummary" - } - }, - "microF1": { - "format": "float", - "description": "Represents the micro F1", - "type": "number" - }, - "microPrecision": { - "format": "float", - "description": "Represents the micro precision", - "type": "number" - }, - "microRecall": { - "format": "float", - "description": "Represents the micro recall", - "type": "number" - }, - "macroF1": { - "format": "float", - "description": "Represents the macro F1", - "type": "number" - }, - "macroPrecision": { - "format": "float", - "description": "Represents the macro precision", - "type": "number" - }, - "macroRecall": { - "format": "float", - "description": "Represents the macro recall", - "type": "number" - } - }, - "x-ms-client-name": "MultiLabelClassificationEvaluationSummary" - }, - "TextAnalysisAuthoringProjectDeletionJobState": { - "description": "Represents the state of a project deletion job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "ProjectDeletionJobState" - }, - "TextAnalysisAuthoringProjectDeployment": { - "description": "Represents a project deployment.", - "required": [ - "deploymentName", - "modelId", - "lastTrainedDateTime", - "lastDeployedDateTime", - "deploymentExpirationDate", - "modelTrainingConfigVersion" - ], - "type": "object", - "properties": { - "deploymentName": { - "description": "Represents deployment name.", - "type": "string" - }, - "modelId": { - "description": "Represents deployment modelId.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "Represents deployment last trained time.", - "type": "string" - }, - "lastDeployedDateTime": { - "format": "date-time", - "description": "Represents deployment last deployed time.", - "type": "string" - }, - "deploymentExpirationDate": { - "format": "date", - "description": "Represents deployment expiration date in the runtime.", - "type": "string" - }, - "modelTrainingConfigVersion": { - "description": "Represents model training config version.", - "type": "string" - } - }, - "x-ms-client-name": "ProjectDeployment" - }, - "TextAnalysisAuthoringProjectDeployments": { - "description": "Represents a list of retrieved deployments.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved deployments.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployment" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectDeployments" - }, - "TextAnalysisAuthoringProjectKind": { - "enum": [ - "CustomSingleLabelClassification", - "CustomMultiLabelClassification", - "CustomEntityRecognition" - ], - "type": "string", - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "value": "CustomSingleLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B." - }, - { - "value": "CustomMultiLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C." - }, - { - "value": "CustomEntityRecognition", - "description": "For building an extraction model to identify your domain categories using your own data." - } - ] - }, - "x-ms-client-name": "ProjectKind" - }, - "TextAnalysisAuthoringProjectMetadata": { - "description": "Represents the metadata of a project.", - "required": [ - "createdDateTime", - "lastModifiedDateTime", - "projectKind", - "storageInputContainerName", - "projectName", - "language" - ], - "type": "object", - "properties": { - "createdDateTime": { - "format": "date-time", - "description": "Represents the project creation datetime.", - "type": "string" - }, - "lastModifiedDateTime": { - "format": "date-time", - "description": "Represents the project last modification datetime.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "Represents the project last training datetime.", - "type": "string" - }, - "lastDeployedDateTime": { - "format": "date-time", - "description": "Represents the project last deployment datetime.", - "type": "string" - }, - "projectKind": { - "description": "The project kind.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" - }, - "storageInputContainerName": { - "description": "The storage container name.", - "type": "string" - }, - "settings": { - "description": "The project settings.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectSettings" - }, - "projectName": { - "description": "The new project name.", - "type": "string" - }, - "multilingual": { - "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" - }, - "description": { - "description": "The project description.", - "type": "string" - }, - "language": { - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "ProjectMetadata" - }, - "TextAnalysisAuthoringProjectSettings": { - "description": "Represents the settings used to define the project behavior.", - "type": "object", - "x-ms-client-name": "ProjectSettings" - }, - "TextAnalysisAuthoringProjectsMetadata": { - "description": "Represents a list of retrieved projects' metadata.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of projects.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectsMetadata" - }, - "TextAnalysisAuthoringProjectTrainedModel": { - "description": "Represents a trained model.", - "required": [ - "label", - "modelId", - "lastTrainedDateTime", - "lastTrainingDurationInSeconds", - "modelExpirationDate", - "modelTrainingConfigVersion" - ], - "type": "object", - "properties": { - "label": { - "description": "The trained model label.", - "type": "string" - }, - "modelId": { - "description": "The model ID.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "The last trained date time of the model.", - "type": "string" - }, - "lastTrainingDurationInSeconds": { - "format": "int32", - "description": "The duration of the model's last training request in seconds.", - "type": "integer" - }, - "modelExpirationDate": { - "format": "date", - "description": "The model expiration date.", - "type": "string" - }, - "modelTrainingConfigVersion": { - "description": "The model training config version.", - "type": "string" - } - }, - "x-ms-client-name": "ProjectTrainedModel" - }, - "TextAnalysisAuthoringProjectTrainedModels": { - "description": "Represents a list of retrieved trained models.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved jobs.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModel" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectTrainedModels" - }, - "TextAnalysisAuthoringSingleLabelClassEvaluationSummary": { - "description": "Represents the evaluation summary for a class in a single-label classification project.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], - "type": "object", - "properties": { - "f1": { - "format": "double", - "description": "Represents the model precision", - "type": "number" - }, - "precision": { - "format": "double", - "description": "Represents the model recall", - "type": "number" - }, - "recall": { - "format": "double", - "description": "Represents the model F1 score", - "type": "number" - }, - "truePositiveCount": { - "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" - }, - "trueNegativeCount": { - "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" - }, - "falsePositiveCount": { - "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" - }, - "falseNegativeCount": { - "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" - } - }, - "x-ms-client-name": "SingleLabelClassEvaluationSummary" - }, - "TextAnalysisAuthoringSingleLabelClassificationEvaluationSummary": { - "description": "Represents the evaluation summary for a custom single-label classification project.", - "required": [ - "confusionMatrix", - "classes", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], - "type": "object", - "properties": { - "confusionMatrix": { - "description": "Represents the confusion matrix between two classes (the two classes can be the same). The matrix is between the class that was labelled and the class that was predicted.", - "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrix" - }, - "classes": { - "description": "Represents the classes evaluation", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringSingleLabelClassEvaluationSummary" - } - }, - "microF1": { - "format": "float", - "description": "Represents the micro F1", - "type": "number" - }, - "microPrecision": { - "format": "float", - "description": "Represents the micro precision", - "type": "number" - }, - "microRecall": { - "format": "float", - "description": "Represents the micro recall", - "type": "number" - }, - "macroF1": { - "format": "float", - "description": "Represents the macro F1", - "type": "number" - }, - "macroPrecision": { - "format": "float", - "description": "Represents the macro precision", - "type": "number" - }, - "macroRecall": { - "format": "float", - "description": "Represents the macro recall", - "type": "number" - } - }, - "x-ms-client-name": "SingleLabelClassificationEvaluationSummary" - }, - "TextAnalysisAuthoringStringIndexType": { - "enum": [ - "Utf16CodeUnit" - ], - "type": "string", - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - }, - "x-ms-client-name": "StringIndexType" - }, - "TextAnalysisAuthoringSubTrainingJobState": { - "description": "Represents the detailed state of a training sub-operation.", - "required": [ - "percentComplete", - "status" - ], - "type": "object", - "properties": { - "percentComplete": { - "format": "int32", - "description": "Represents progress percentage.", - "type": "integer" - }, - "startDateTime": { - "format": "date-time", - "description": "Represents the start date time.", - "type": "string" - }, - "endDateTime": { - "format": "date-time", - "description": "Represents the end date time.", - "type": "string" - }, - "status": { - "description": "Represents the status of the sub-operation.", - "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" - } - }, - "x-ms-client-name": "SubTrainingJobState" - }, - "TextAnalysisAuthoringSupportedLanguage": { - "description": "Represents a supported language.", - "required": [ - "languageName", - "languageCode" - ], - "type": "object", - "properties": { - "languageName": { - "description": "The language name.", - "type": "string" - }, - "languageCode": { - "description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "SupportedLanguage" - }, - "TextAnalysisAuthoringSupportedLanguages": { - "description": "Represents a list of retrieved languages.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of the languages.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringSupportedLanguage" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "SupportedLanguages" - }, - "TextAnalysisAuthoringSwapDeploymentsOptions": { - "description": "Represents the options for swapping two deployments together.", - "required": [ - "firstDeploymentName", - "secondDeploymentName" - ], - "type": "object", - "properties": { - "firstDeploymentName": { - "description": "Represents the first deployment name.", - "type": "string" - }, - "secondDeploymentName": { - "description": "Represents the second deployment name.", - "type": "string" - } - }, - "x-ms-client-name": "SwapDeploymentsOptions" - }, - "TextAnalysisAuthoringTrainingConfigVersion": { - "description": "Represents a training config version.", - "required": [ - "trainingConfigVersion", - "modelExpirationDate" - ], - "type": "object", - "properties": { - "trainingConfigVersion": { - "description": "Represents the version of the config.", - "type": "string" - }, - "modelExpirationDate": { - "format": "date", - "description": "Represents the training config version expiration date.", - "type": "string" - } - }, - "x-ms-client-name": "TrainingConfigVersion" - }, - "TextAnalysisAuthoringTrainingConfigVersions": { - "description": "Represents a list of training config versions.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of the training config versions.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingConfigVersion" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "TrainingConfigVersions" - }, - "TextAnalysisAuthoringTrainingJobOptions": { - "description": "Represents the options for starting a new training job.", - "required": [ - "modelLabel", - "trainingConfigVersion" - ], - "type": "object", - "properties": { - "modelLabel": { - "description": "Represents the output model label.", - "type": "string" - }, - "trainingConfigVersion": { - "description": "Represents training config version.", - "type": "string" - }, - "evaluationOptions": { - "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20.", - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions" - } - }, - "x-ms-client-name": "TrainingJobOptions" - }, - "TextAnalysisAuthoringTrainingJobResult": { - "description": "Represents the output of a training job.", - "required": [ - "modelLabel", - "trainingConfigVersion", - "trainingStatus" - ], - "type": "object", - "properties": { - "modelLabel": { - "description": "Represents trained model label.", - "type": "string" - }, - "trainingConfigVersion": { - "description": "Represents training config version.", - "type": "string" - }, - "trainingStatus": { - "description": "Represents model train status.", - "$ref": "#/definitions/TextAnalysisAuthoringSubTrainingJobState" - }, - "evaluationStatus": { - "description": "Represents model evaluation status.", - "$ref": "#/definitions/TextAnalysisAuthoringSubTrainingJobState" - }, - "estimatedEndDateTime": { - "format": "date-time", - "description": "Represents the estimate end date time for training and evaluation.", - "type": "string" - } - }, - "x-ms-client-name": "TrainingJobResult" - }, - "TextAnalysisAuthoringTrainingJobs": { - "description": "Represents a list of retrieved training jobs.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of jobs.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobState" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "TrainingJobs" - }, - "TextAnalysisAuthoringTrainingJobState": { - "description": "Represents the state of a training job.", - "required": [ - "result" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringJobState" - } - ], - "properties": { - "result": { - "description": "Represents training tasks detailed result.", - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobResult" - } - }, - "x-ms-client-name": "TrainingJobState" - }, - "TextAnalysisAuthoringWarning": { - "description": "Represents a warning that was encountered while executing the request.", - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "description": "The warning code.", - "type": "string" - }, - "message": { - "description": "The warning message.", - "type": "string" - } - }, - "x-ms-client-name": "Warning" - } - }, - "parameters": { - "TextAnalysisAuthoringStringIndexTypeQueryParameter": { - "in": "query", - "name": "stringIndexType", - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "required": true, - "type": "string", - "enum": [ - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "TextAnalysisAuthoringJobIdPathParameter": { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "TextAnalysisAuthoringTrainedModelLabelPathParameter": { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model label.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "TextAnalysisAuthoringProjectKindQueryParameter": { - "in": "query", - "name": "projectKind", - "description": "The project kind.", - "required": true, - "type": "string", - "enum": [ - "CustomSingleLabelClassification", - "CustomMultiLabelClassification", - "CustomEntityRecognition" - ], - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "value": "CustomSingleLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B." - }, - { - "value": "CustomMultiLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C." - }, - { - "value": "CustomEntityRecognition", - "description": "For building an extraction model to identify your domain categories using your own data." - } - ] - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/analyzetext.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/analyzetext.json deleted file mode 100644 index 8935b65892fa..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/analyzetext.json +++ /dev/null @@ -1,2676 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Text Analysis", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview.0", - "version": "2022-05-15-preview" - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/:analyze-text": { - "post": { - "summary": "Request text analysis over a collection of documents.", - "description": "Submit a collection of text documents for analysis. Specify a single unique task to be executed immediately.", - "operationId": "AnalyzeText", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/ShowStats" - }, - { - "description": "Collection of documents to analyze and a single task to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeTextTask" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "A successful call result", - "schema": { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Entity Linking Request": { - "$ref": "./examples/SuccessfulEntityLinkingRequest.json" - }, - "Successful Entity Recognition Request": { - "$ref": "./examples/SuccessfulEntityRecognitionRequest.json" - }, - "Successful Key Phrase Extraction Request": { - "$ref": "./examples/SuccessfulKeyPhraseExtractionRequest.json" - }, - "Successful PII Entity Recognition Request": { - "$ref": "./examples/SuccessfulPiiEntityRecognitionRequest.json" - }, - "Successful Language Detection Request": { - "$ref": "./examples/SuccessfulLanguageDetectionRequest.json" - }, - "Successful Sentiment Analysis Request": { - "$ref": "./examples/SuccessfulSentimentAnalysisRequest.json" - } - } - } - }, - "/analyze-text/jobs": { - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "description": "Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.", - "operationId": "AnalyzeText_SubmitJob", - "summary": "Submit text analysis job", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Collection of documents to analyze and one or more tasks to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeTextJobsInput" - }, - "required": true - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Submit Analysis Job Request": { - "$ref": "./examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/analyze-text/jobs/{jobId}": { - "get": { - "produces": [ - "application/json" - ], - "description": "Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are succeeded, the job will transition to the succeeded state and results will be available for each task.", - "operationId": "AnalyzeText_JobStatus", - "summary": "Get analysis status and results", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/JobId" - }, - { - "$ref": "common.json#/parameters/ShowStats" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - } - ], - "responses": { - "200": { - "description": "Analysis job status and metadata.", - "schema": { - "$ref": "#/definitions/AnalyzeTextJobState" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Text Analysis Job Status Request": { - "$ref": "./examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json" - } - } - } - }, - "/analyze-text/jobs/{jobId}:cancel": { - "post": { - "produces": [ - "application/json" - ], - "description": "Cancel a long-running Text Analysis job.", - "operationId": "AnalyzeText_CancelJob", - "summary": "Cancel a long-running Text Analysis job", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/JobId" - } - ], - "responses": { - "202": { - "description": "Cancel Job request has been received.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Job Delete Request": { - "$ref": ".//examples//SuccessfulAnalyzeTextJobsCancelRequest.json" - } - }, - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "AnalyzeTextTaskKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis tasks.", - "enum": [ - "SentimentAnalysis", - "EntityRecognition", - "PiiEntityRecognition", - "KeyPhraseExtraction", - "LanguageDetection", - "EntityLinking" - ], - "x-ms-enum": { - "name": "AnalyzeTextTaskKind", - "modelAsString": true - } - }, - "AnalyzeTextLROTaskKind": { - "type": "string", - "description": "Enumeration of supported long-running Text Analysis tasks.", - "enum": [ - "SentimentAnalysis", - "EntityRecognition", - "PiiEntityRecognition", - "KeyPhraseExtraction", - "EntityLinking", - "Healthcare", - "ExtractiveSummarization", - "CustomEntityRecognition", - "CustomSingleLabelClassification", - "CustomMultiLabelClassification" - ], - "x-ms-enum": { - "name": "AnalyzeTextLROTaskKind", - "modelAsString": true - } - }, - "AnalyzeTextTaskResultsKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis task results.", - "enum": [ - "SentimentAnalysisResults", - "EntityRecognitionResults", - "PiiEntityRecognitionResults", - "KeyPhraseExtractionResults", - "LanguageDetectionResults", - "EntityLinkingResults" - ], - "x-ms-enum": { - "name": "AnalyzeTextTaskResultsKind", - "modelAsString": true - } - }, - "AnalyzeTextLROResultsKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis long-running operation task results.", - "enum": [ - "SentimentAnalysisLROResults", - "EntityRecognitionLROResults", - "PiiEntityRecognitionLROResults", - "KeyPhraseExtractionLROResults", - "EntityLinkingLROResults", - "HealthcareLROResults", - "ExtractiveSummarizationLROResults", - "CustomEntityRecognitionLROResults", - "CustomSingleLabelClassificationLROResults", - "CustomMultiLabelClassificationLROResults" - ], - "x-ms-enum": { - "name": "AnalyzeTextLROResultsKind", - "modelAsString": true - } - }, - "MultiLanguageAnalysisInput": { - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/definitions/MultiLanguageInput" - } - } - } - }, - "LanguageDetectionAnalysisInput": { - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/definitions/LanguageInput" - } - } - } - }, - "AnalyzeTextTask": { - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextTaskKind" - } - } - }, - "AnalyzeTextLROTask": { - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextLROTaskKind" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskIdentifier" - } - ] - }, - "AnalyzeTextTaskResult": { - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextTaskResultsKind" - } - } - }, - "AnalyzeTextEntityLinkingInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/EntityLinkingTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "EntityLinking" - }, - "AnalyzeTextEntityRecognitionInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/EntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "EntityRecognition" - }, - "AnalyzeTextKeyPhraseExtractionInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/KeyPhraseTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "KeyPhraseExtraction" - }, - "AnalyzeTextPiiEntitiesRecognitionInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/PiiTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "PiiEntityRecognition" - }, - "AnalyzeTextLanguageDetectionInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/LanguageDetectionAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/LanguageDetectionTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "LanguageDetection" - }, - "AnalyzeTextSentimentAnalysisInput": { - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/SentimentAnalysisTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "SentimentAnalysis" - }, - "AnalyzeTextJobsInput": { - "properties": { - "displayName": { - "description": "Optional display name for the analysis job.", - "type": "string" - }, - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "tasks": { - "description": "The set of tasks to execute on the input documents.", - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - } - }, - "required": [ - "analysisInput", - "tasks" - ] - }, - "CustomTaskParameters": { - "type": "object", - "description": "Parameters object for a text analysis task using custom models.", - "properties": { - "projectName": { - "type": "string", - "description": "This field indicates the project name for the model." - }, - "deploymentName": { - "type": "string", - "description": "This field indicates the deployment name for the model." - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskParameters" - } - ], - "required": [ - "projectName", - "deploymentName" - ] - }, - "CustomResult": { - "properties": { - "errors": { - "type": "array", - "description": "Errors by document id.", - "items": { - "$ref": "#/definitions/DocumentError" - } - }, - "statistics": { - "$ref": "common.json#/definitions/RequestStatistics" - }, - "projectName": { - "type": "string", - "description": "This field indicates the project name for the model." - }, - "deploymentName": { - "type": "string", - "description": "This field indicates the deployment name for the model." - } - }, - "required": [ - "errors", - "projectName", - "deploymentName" - ] - }, - "CustomEntitiesTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Entities task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/CustomTaskParameters" - } - ] - }, - "CustomEntitiesLROTask": { - "type": "object", - "description": "Use custom models to ease the process of information extraction from unstructured documents like contracts or financial documents", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomEntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomEntityRecognition" - }, - "CustomEntitiesResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/EntitiesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/CustomResult" - } - ], - "required": [ - "documents" - ] - }, - "CustomSingleLabelClassificationTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Single Classification task.", - "allOf": [ - { - "$ref": "#/definitions/CustomTaskParameters" - } - ] - }, - "CustomSingleLabelClassificationLROTask": { - "type": "object", - "description": "Use custom models to classify text into single label taxonomy", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomSingleLabelClassificationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomSingleLabelClassification" - }, - "CustomLabelClassificationResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/ClassificationDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/CustomResult" - } - ], - "required": [ - "documents" - ] - }, - "ClassificationResult": { - "type": "object", - "required": [ - "category", - "confidenceScore" - ], - "properties": { - "category": { - "type": "string", - "description": "Classification type." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the recognized class." - } - } - }, - "CustomMultiLabelClassificationTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Multi Classification task.", - "allOf": [ - { - "$ref": "#/definitions/CustomTaskParameters" - } - ] - }, - "CustomMultiLabelClassificationLROTask": { - "type": "object", - "description": "Use custom models to classify text into multi label taxonomy", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomMultiLabelClassificationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomMultiLabelClassification" - }, - "ClassificationDocumentResult": { - "type": "object", - "properties": { - "class": { - "type": "array", - "items": { - "$ref": "#/definitions/ClassificationResult" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "class" - ] - }, - "HealthcareTaskParameters": { - "type": "object", - "description": "Supported parameters for a Healthcare task.", - "properties": { - "fhirVersion": { - "type": "string", - "description": "The FHIR Spec version that the result will use to format the fhirBundle. For additional information see https://www.hl7.org/fhir/overview.html.", - "enum": [ - "4.0.1" - ], - "x-ms-enum": { - "name": "fhirVersion", - "modelAsString": true - } - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "HealthcareLROTask": { - "type": "object", - "properties": { - "parameters": { - "$ref": "#/definitions/HealthcareTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "Healthcare" - }, - "HealthcareResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "#/definitions/HealthcareEntitiesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "HealthcareEntitiesDocumentResult": { - "type": "object", - "properties": { - "entities": { - "description": "Healthcare entities.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareEntity" - } - }, - "relations": { - "type": "array", - "description": "Healthcare entity relations.", - "items": { - "$ref": "#/definitions/HealthcareRelation" - } - }, - "fhirBundle": { - "type": "object", - "description": "JSON bundle containing a FHIR compatible object for consumption in other Healthcare tools. For additional information see https://www.hl7.org/fhir/overview.html.", - "additionalProperties": {} - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "entities", - "relations" - ] - }, - "HealthcareEntity": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "x-ms-enum": { - "name": "healthcareEntityCategory", - "modelAsString": true - }, - "type": "string", - "description": "Healthcare Entity Category.", - "enum": [ - "BODY_STRUCTURE", - "AGE", - "GENDER", - "EXAMINATION_NAME", - "DATE", - "DIRECTION", - "FREQUENCY", - "MEASUREMENT_VALUE", - "MEASUREMENT_UNIT", - "RELATIONAL_OPERATOR", - "TIME", - "GENE_OR_PROTEIN", - "VARIANT", - "ADMINISTRATIVE_EVENT", - "CARE_ENVIRONMENT", - "HEALTHCARE_PROFESSION", - "DIAGNOSIS", - "SYMPTOM_OR_SIGN", - "CONDITION_QUALIFIER", - "MEDICATION_CLASS", - "MEDICATION_NAME", - "DOSAGE", - "MEDICATION_FORM", - "MEDICATION_ROUTE", - "FAMILY_RELATION", - "TREATMENT_NAME" - ] - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub type." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted entity." - }, - "assertion": { - "type": "object", - "$ref": "#/definitions/HealthcareAssertion" - }, - "name": { - "description": "Preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'.", - "type": "string" - }, - "links": { - "description": "Entity references in known data sources.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareEntityLink" - } - } - }, - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ] - }, - "HealthcareRelation": { - "type": "object", - "description": "Every relation is an entity graph of a certain relationType, where all entities are connected and have specific roles within the relation context.", - "required": [ - "relationType", - "entities" - ], - "properties": { - "relationType": { - "description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc.", - "type": "string", - "enum": [ - "Abbreviation", - "DirectionOfBodyStructure", - "DirectionOfCondition", - "DirectionOfExamination", - "DirectionOfTreatment", - "DosageOfMedication", - "FormOfMedication", - "FrequencyOfMedication", - "FrequencyOfTreatment", - "QualifierOfCondition", - "RelationOfExamination", - "RouteOfMedication", - "TimeOfCondition", - "TimeOfEvent", - "TimeOfExamination", - "TimeOfMedication", - "TimeOfTreatment", - "UnitOfCondition", - "UnitOfExamination", - "ValueOfCondition", - "ValueOfExamination" - ], - "x-ms-enum": { - "name": "relationType", - "modelAsString": true - } - }, - "entities": { - "description": "The entities in the relation.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareRelationEntity" - } - } - } - }, - "HealthcareAssertion": { - "type": "object", - "properties": { - "conditionality": { - "description": "Describes any conditionality on the entity.", - "type": "string", - "enum": [ - "hypothetical", - "conditional" - ], - "x-ms-enum": { - "name": "Conditionality", - "modelAsString": false - } - }, - "certainty": { - "description": "Describes the entities certainty and polarity.", - "type": "string", - "enum": [ - "positive", - "positivePossible", - "neutralPossible", - "negativePossible", - "negative" - ], - "x-ms-enum": { - "name": "Certainty", - "modelAsString": false - } - }, - "association": { - "description": "Describes if the entity is the subject of the text or if it describes someone else.", - "type": "string", - "enum": [ - "subject", - "other" - ], - "x-ms-enum": { - "name": "Association", - "modelAsString": false - } - } - } - }, - "HealthcareRelationEntity": { - "type": "object", - "required": [ - "ref", - "role" - ], - "properties": { - "ref": { - "description": "Reference link object, using a JSON pointer RFC 6901 (URI Fragment Identifier Representation), pointing to the entity .", - "type": "string" - }, - "role": { - "description": "Role of entity in the relationship. For example: 'CD20-positive diffuse large B-cell lymphoma' has the following entities with their roles in parenthesis: CD20 (GeneOrProtein), Positive (Expression), diffuse large B-cell lymphoma (Diagnosis).", - "type": "string" - } - } - }, - "HealthcareEntityLink": { - "type": "object", - "required": [ - "dataSource", - "id" - ], - "properties": { - "dataSource": { - "description": "Entity Catalog. Examples include: UMLS, CHV, MSH, etc.", - "type": "string" - }, - "id": { - "description": "Entity id in the given source catalog.", - "type": "string" - } - } - }, - "SentimentAnalysisTaskParameters": { - "type": "object", - "description": "Supported parameters for a Sentiment Analysis task.", - "properties": { - "opinionMining": { - "type": "boolean", - "default": false - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "SentimentAnalysisLROTask": { - "type": "object", - "description": "An object representing the task definition for a Sentiment Analysis task.", - "properties": { - "parameters": { - "$ref": "#/definitions/SentimentAnalysisTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "SentimentAnalysis" - }, - "SentimentTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/SentimentResponse" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "SentimentAnalysisResults" - }, - "SentimentResponse": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Sentiment analysis per document.", - "items": { - "allOf": [ - { - "$ref": "#/definitions/SentimentDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "SentimentDocumentResult": { - "type": "object", - "properties": { - "sentiment": { - "type": "string", - "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).", - "enum": [ - "positive", - "neutral", - "negative", - "mixed" - ], - "x-ms-enum": { - "name": "DocumentSentimentValue", - "modelAsString": false - } - }, - "confidenceScores": { - "description": "Document level sentiment confidence scores between 0 and 1 for each sentiment class.", - "$ref": "#/definitions/SentimentConfidenceScorePerLabel" - }, - "sentences": { - "type": "array", - "description": "Sentence level sentiment analysis.", - "items": { - "$ref": "#/definitions/SentenceSentiment" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "sentiment", - "confidenceScores", - "sentences" - ] - }, - "SentimentConfidenceScorePerLabel": { - "type": "object", - "required": [ - "positive", - "neutral", - "negative" - ], - "properties": { - "positive": { - "type": "number", - "format": "double", - "description": "Confidence score for positive sentiment" - }, - "neutral": { - "type": "number", - "format": "double", - "description": "Confidence score for neutral sentiment" - }, - "negative": { - "type": "number", - "format": "double", - "description": "Confidence score for negative sentiment" - } - }, - "description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative." - }, - "SentenceSentiment": { - "type": "object", - "required": [ - "text", - "sentiment", - "confidenceScores", - "offset", - "length" - ], - "properties": { - "text": { - "type": "string", - "description": "The sentence text." - }, - "sentiment": { - "type": "string", - "description": "The predicted Sentiment for the sentence.", - "enum": [ - "positive", - "neutral", - "negative" - ], - "x-ms-enum": { - "name": "SentenceSentimentValue", - "modelAsString": false - } - }, - "confidenceScores": { - "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes.", - "$ref": "#/definitions/SentimentConfidenceScorePerLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The sentence offset from the start of the document." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the sentence." - }, - "targets": { - "type": "array", - "description": "The array of sentence targets for the sentence.", - "items": { - "$ref": "#/definitions/SentenceTarget" - } - }, - "assessments": { - "type": "array", - "description": "The array of assessments for the sentence.", - "items": { - "$ref": "#/definitions/SentenceAssessment" - } - } - } - }, - "SentenceTarget": { - "type": "object", - "required": [ - "confidenceScores", - "length", - "offset", - "relations", - "sentiment", - "text" - ], - "properties": { - "sentiment": { - "type": "string", - "enum": [ - "positive", - "mixed", - "negative" - ], - "x-ms-enum": { - "name": "TokenSentimentValue", - "modelAsString": false - }, - "description": "Targeted sentiment in the sentence." - }, - "confidenceScores": { - "description": "Target sentiment confidence scores for the target in the sentence.", - "$ref": "#/definitions/TargetConfidenceScoreLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The target offset from the start of the sentence." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the target." - }, - "text": { - "type": "string", - "description": "The target text detected." - }, - "relations": { - "type": "array", - "description": "The array of either assessment or target objects which is related to the target.", - "items": { - "$ref": "#/definitions/TargetRelation" - } - } - } - }, - "SentenceAssessment": { - "type": "object", - "required": [ - "confidenceScores", - "isNegated", - "length", - "offset", - "sentiment", - "text" - ], - "properties": { - "sentiment": { - "type": "string", - "enum": [ - "positive", - "mixed", - "negative" - ], - "x-ms-enum": { - "name": "TokenSentimentValue", - "modelAsString": false - }, - "description": "Assessment sentiment in the sentence." - }, - "confidenceScores": { - "description": "Assessment sentiment confidence scores in the sentence.", - "$ref": "#/definitions/TargetConfidenceScoreLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The assessment offset from the start of the sentence." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the assessment." - }, - "text": { - "type": "string", - "description": "The assessment text detected." - }, - "isNegated": { - "type": "boolean", - "description": "The indicator representing if the assessment is negated." - } - } - }, - "TargetRelation": { - "type": "object", - "required": [ - "ref", - "relationType" - ], - "properties": { - "relationType": { - "type": "string", - "enum": [ - "assessment", - "target" - ], - "x-ms-enum": { - "name": "TargetRelationType", - "modelAsString": false - }, - "description": "The type related to the target." - }, - "ref": { - "type": "string", - "description": "The JSON pointer indicating the linked object." - } - } - }, - "TargetConfidenceScoreLabel": { - "type": "object", - "required": [ - "negative", - "positive" - ], - "properties": { - "positive": { - "type": "number", - "format": "double", - "description": "Confidence score for positive sentiment" - }, - "negative": { - "type": "number", - "format": "double", - "description": "Confidence score for negative sentiment" - } - }, - "description": "Represents the confidence scores across all sentiment classes: positive and negative." - }, - "EntitiesTaskParameters": { - "type": "object", - "description": "Supported parameters for an Entity Recognition task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "EntitiesLROTask": { - "type": "object", - "description": "An object representing the task definition for an Entities Recognition task.", - "properties": { - "parameters": { - "$ref": "#/definitions/EntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "EntityRecognition" - }, - "EntitiesTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityRecognitionResults" - }, - "EntitiesResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/EntitiesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "EntitiesDocumentResult": { - "type": "object", - "properties": { - "entities": { - "type": "array", - "description": "Recognized entities in the document.", - "items": { - "$ref": "#/definitions/Entity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "entities" - ] - }, - "Entity": { - "type": "object", - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ], - "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "type": "string", - "description": "Entity type." - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub type." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted entity." - } - } - }, - "EntityLinkingTaskParameters": { - "type": "object", - "description": "Supported parameters for an Entity Linking task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "EntityLinkingLROTask": { - "type": "object", - "description": "An object representing the task definition for an Entity Linking task.", - "properties": { - "parameters": { - "$ref": "#/definitions/EntityLinkingTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "EntityLinking" - }, - "EntityLinkingTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntityLinkingResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityLinkingResults" - }, - "EntityLinkingResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/LinkedEntitiesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "LinkedEntitiesDocumentResult": { - "type": "object", - "required": [ - "entities" - ], - "properties": { - "entities": { - "type": "array", - "description": "Recognized well known entities in the document.", - "items": { - "$ref": "#/definitions/LinkedEntity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ] - }, - "LinkedEntity": { - "type": "object", - "required": [ - "name", - "matches", - "language", - "url", - "dataSource" - ], - "properties": { - "name": { - "type": "string", - "description": "Entity Linking formal name." - }, - "matches": { - "type": "array", - "description": "List of instances this entity appears in the text.", - "items": { - "$ref": "#/definitions/Match" - } - }, - "language": { - "type": "string", - "description": "Language used in the data source." - }, - "id": { - "type": "string", - "description": "Unique identifier of the recognized entity from the data source." - }, - "url": { - "type": "string", - "description": "URL for the entity's page from the data source." - }, - "dataSource": { - "type": "string", - "description": "Data source used to extract entity linking, such as Wiki/Bing etc." - }, - "bingId": { - "type": "string", - "description": "Bing Entity Search API unique identifier of the recognized entity." - } - } - }, - "Match": { - "type": "object", - "required": [ - "confidenceScore", - "text", - "offset", - "length" - ], - "properties": { - "confidenceScore": { - "type": "number", - "format": "double", - "description": "If a well known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned." - }, - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity match text." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity match text." - } - } - }, - "PiiTaskParameters": { - "type": "object", - "description": "Supported parameters for a PII Entities Recognition task.", - "properties": { - "domain": { - "$ref": "#/definitions/PiiDomain" - }, - "piiCategories": { - "$ref": "#/definitions/PiiCategories" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "PiiLROTask": { - "type": "object", - "description": "An object representing the task definition for a PII Entities Recognition task.", - "properties": { - "parameters": { - "$ref": "#/definitions/PiiTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "PiiEntityRecognition" - }, - "PiiTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/PiiResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "PiiEntityRecognitionResults" - }, - "PiiResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/PiiEntitiesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "PiiDomain": { - "type": "string", - "description": "The PII domain used for PII Entity Recognition.", - "default": "none", - "enum": [ - "phi", - "none" - ], - "x-ms-enum": { - "name": "PiiDomain", - "modelAsString": true, - "values": [ - { - "name": "phi", - "description": "Indicates that entities in the Personal Health Information domain should be redacted.", - "value": "phi" - }, - { - "name": "none", - "description": "Indicates that no domain is specified.", - "value": "none" - } - ] - } - }, - "PiiEntitiesDocumentResult": { - "type": "object", - "properties": { - "redactedText": { - "type": "string", - "description": "Returns redacted text." - }, - "entities": { - "type": "array", - "description": "Recognized entities in the document.", - "items": { - "$ref": "#/definitions/Entity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "redactedText", - "entities" - ] - }, - "PiiCategories": { - "description": "(Optional) describes the PII categories to return", - "items": { - "type": "string", - "x-ms-enum": { - "name": "PiiCategory", - "modelAsString": true - }, - "enum": [ - "ABARoutingNumber", - "ARNationalIdentityNumber", - "AUBankAccountNumber", - "AUDriversLicenseNumber", - "AUMedicalAccountNumber", - "AUPassportNumber", - "AUTaxFileNumber", - "AUBusinessNumber", - "AUCompanyNumber", - "ATIdentityCard", - "ATTaxIdentificationNumber", - "ATValueAddedTaxNumber", - "AzureDocumentDBAuthKey", - "AzureIAASDatabaseConnectionAndSQLString", - "AzureIoTConnectionString", - "AzurePublishSettingPassword", - "AzureRedisCacheString", - "AzureSAS", - "AzureServiceBusString", - "AzureStorageAccountKey", - "AzureStorageAccountGeneric", - "BENationalNumber", - "BENationalNumberV2", - "BEValueAddedTaxNumber", - "BRCPFNumber", - "BRLegalEntityNumber", - "BRNationalIDRG", - "BGUniformCivilNumber", - "CABankAccountNumber", - "CADriversLicenseNumber", - "CAHealthServiceNumber", - "CAPassportNumber", - "CAPersonalHealthIdentification", - "CASocialInsuranceNumber", - "CLIdentityCardNumber", - "CNResidentIdentityCardNumber", - "CreditCardNumber", - "HRIdentityCardNumber", - "HRNationalIDNumber", - "HRPersonalIdentificationNumber", - "HRPersonalIdentificationOIBNumberV2", - "CYIdentityCard", - "CYTaxIdentificationNumber", - "CZPersonalIdentityNumber", - "CZPersonalIdentityV2", - "DKPersonalIdentificationNumber", - "DKPersonalIdentificationV2", - "DrugEnforcementAgencyNumber", - "EEPersonalIdentificationCode", - "EUDebitCardNumber", - "EUDriversLicenseNumber", - "EUGPSCoordinates", - "EUNationalIdentificationNumber", - "EUPassportNumber", - "EUSocialSecurityNumber", - "EUTaxIdentificationNumber", - "FIEuropeanHealthNumber", - "FINationalID", - "FINationalIDV2", - "FIPassportNumber", - "FRDriversLicenseNumber", - "FRHealthInsuranceNumber", - "FRNationalID", - "FRPassportNumber", - "FRSocialSecurityNumber", - "FRTaxIdentificationNumber", - "FRValueAddedTaxNumber", - "DEDriversLicenseNumber", - "DEPassportNumber", - "DEIdentityCardNumber", - "DETaxIdentificationNumber", - "DEValueAddedNumber", - "GRNationalIDCard", - "GRNationalIDV2", - "GRTaxIdentificationNumber", - "HKIdentityCardNumber", - "HUValueAddedNumber", - "HUPersonalIdentificationNumber", - "HUTaxIdentificationNumber", - "INPermanentAccount", - "INUniqueIdentificationNumber", - "IDIdentityCardNumber", - "InternationalBankingAccountNumber", - "IEPersonalPublicServiceNumber", - "IEPersonalPublicServiceNumberV2", - "ILBankAccountNumber", - "ILNationalID", - "ITDriversLicenseNumber", - "ITFiscalCode", - "ITValueAddedTaxNumber", - "JPBankAccountNumber", - "JPDriversLicenseNumber", - "JPPassportNumber", - "JPResidentRegistrationNumber", - "JPSocialInsuranceNumber", - "JPMyNumberCorporate", - "JPMyNumberPersonal", - "JPResidenceCardNumber", - "LVPersonalCode", - "LTPersonalCode", - "LUNationalIdentificationNumberNatural", - "LUNationalIdentificationNumberNonNatural", - "MYIdentityCardNumber", - "MTIdentityCardNumber", - "MTTaxIDNumber", - "NLCitizensServiceNumber", - "NLCitizensServiceNumberV2", - "NLTaxIdentificationNumber", - "NLValueAddedTaxNumber", - "NZBankAccountNumber", - "NZDriversLicenseNumber", - "NZInlandRevenueNumber", - "NZMinistryOfHealthNumber", - "NZSocialWelfareNumber", - "NOIdentityNumber", - "PHUnifiedMultiPurposeIDNumber", - "PLIdentityCard", - "PLNationalID", - "PLNationalIDV2", - "PLPassportNumber", - "PLTaxIdentificationNumber", - "PLREGONNumber", - "PTCitizenCardNumber", - "PTCitizenCardNumberV2", - "PTTaxIdentificationNumber", - "ROPersonalNumericalCode", - "RUPassportNumberDomestic", - "RUPassportNumberInternational", - "SANationalID", - "SGNationalRegistrationIdentityCardNumber", - "SKPersonalNumber", - "SITaxIdentificationNumber", - "SIUniqueMasterCitizenNumber", - "ZAIdentificationNumber", - "KRResidentRegistrationNumber", - "ESDNI", - "ESSocialSecurityNumber", - "ESTaxIdentificationNumber", - "SQLServerConnectionString", - "SENationalID", - "SENationalIDV2", - "SEPassportNumber", - "SETaxIdentificationNumber", - "SWIFTCode", - "CHSocialSecurityNumber", - "TWNationalID", - "TWPassportNumber", - "TWResidentCertificate", - "THPopulationIdentificationCode", - "TRNationalIdentificationNumber", - "UKDriversLicenseNumber", - "UKElectoralRollNumber", - "UKNationalHealthNumber", - "UKNationalInsuranceNumber", - "UKUniqueTaxpayerNumber", - "USUKPassportNumber", - "USBankAccountNumber", - "USDriversLicenseNumber", - "USIndividualTaxpayerIdentification", - "USSocialSecurityNumber", - "UAPassportNumberDomestic", - "UAPassportNumberInternational", - "Organization", - "Email", - "URL", - "Age", - "PhoneNumber", - "IPAddress", - "Date", - "Person", - "Address", - "All", - "Default" - ] - }, - "type": "array", - "uniqueItems": true - }, - "ExtractiveSummarizationTaskParameters": { - "type": "object", - "description": "Supported parameters for an Extractive Summarization task.", - "properties": { - "sentenceCount": { - "type": "integer", - "default": 3 - }, - "sortBy": { - "$ref": "#/definitions/ExtractiveSummarizationSortingCriteria" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "ExtractiveSummarizationLROTask": { - "type": "object", - "description": "An object representing the task definition for an Extractive Summarization task.", - "properties": { - "parameters": { - "$ref": "#/definitions/ExtractiveSummarizationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "ExtractiveSummarization" - }, - "ExtractiveSummarizationResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/ExtractedSummaryDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "ExtractiveSummarizationSortingCriteria": { - "type": "string", - "default": "Offset", - "description": "The sorting criteria to use for the results of Extractive Summarization.", - "enum": [ - "Offset", - "Rank" - ], - "x-ms-enum": { - "name": "ExtractiveSummarizationSortingCriteria", - "modelAsString": true, - "values": [ - { - "name": "Offset", - "description": "Indicates that results should be sorted in order of appearance in the text.", - "value": "Offset" - }, - { - "name": "Rank", - "description": "Indicates that results should be sorted in order of importance (i.e. rank score) according to the model.", - "value": "Rank" - } - ] - } - }, - "ExtractedSummaryDocumentResult": { - "type": "object", - "properties": { - "sentences": { - "type": "array", - "description": "A ranked list of sentences representing the extracted summary.", - "items": { - "$ref": "#/definitions/ExtractedSummarySentence" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "sentences" - ] - }, - "ExtractedSummarySentence": { - "type": "object", - "required": [ - "text", - "rankScore", - "offset", - "length" - ], - "properties": { - "text": { - "type": "string", - "description": "The extracted sentence text." - }, - "rankScore": { - "type": "number", - "format": "double", - "description": "A double value representing the relevance of the sentence within the summary. Higher values indicate higher importance." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The sentence offset from the start of the document, based on the value of the parameter StringIndexType." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the sentence." - } - } - }, - "KeyPhraseTaskParameters": { - "type": "object", - "description": "Supported parameters for a Key Phrase Extraction task.", - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "KeyPhraseLROTask": { - "type": "object", - "description": "An object representing the task definition for a Key Phrase Extraction task.", - "properties": { - "parameters": { - "$ref": "#/definitions/KeyPhraseTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "KeyPhraseExtraction" - }, - "KeyPhraseTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/KeyPhraseResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "KeyPhraseExtractionResults" - }, - "KeyPhraseResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/KeyPhrasesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "KeyPhrasesDocumentResult": { - "type": "object", - "properties": { - "keyPhrases": { - "type": "array", - "description": "A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.", - "items": { - "type": "string" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "keyPhrases" - ] - }, - "LanguageDetectionTaskParameters": { - "type": "object", - "description": "Supported parameters for a Language Detection task.", - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "LanguageDetectionTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/LanguageDetectionResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "LanguageDetectionResults" - }, - "LanguageDetectionResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "$ref": "#/definitions/LanguageDetectionDocumentResult" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "LanguageDetectionDocumentResult": { - "type": "object", - "properties": { - "detectedLanguage": { - "description": "Detected Language.", - "$ref": "#/definitions/DetectedLanguage" - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "detectedLanguage" - ] - }, - "DetectedLanguage": { - "type": "object", - "required": [ - "name", - "iso6391Name", - "confidenceScore" - ], - "properties": { - "name": { - "type": "string", - "description": "Long name of a detected language (e.g. English, French)." - }, - "iso6391Name": { - "type": "string", - "description": "A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr)." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true." - } - } - }, - "AnalyzeTextJobState": { - "allOf": [ - { - "$ref": "common.json#/definitions/JobState" - }, - { - "$ref": "#/definitions/TasksState" - }, - { - "$ref": "#/definitions/AnalyzeTextJobStatistics" - } - ] - }, - "Pagination": { - "properties": { - "nextLink": { - "type": "string" - } - }, - "type": "object" - }, - "AnalyzeTextJobStatistics": { - "properties": { - "statistics": { - "$ref": "common.json#/definitions/RequestStatistics" - } - }, - "type": "object" - }, - "TasksState": { - "properties": { - "tasks": { - "properties": { - "completed": { - "type": "integer" - }, - "failed": { - "type": "integer" - }, - "inProgress": { - "type": "integer" - }, - "total": { - "type": "integer" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - } - }, - "required": [ - "total", - "completed", - "failed", - "inProgress" - ], - "type": "object" - } - }, - "required": [ - "tasks" - ], - "type": "object" - }, - "AnalyzeTextLROResult": { - "type": "object", - "discriminator": "kind", - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextLROResultsKind" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskState" - }, - { - "$ref": "common.json#/definitions/TaskIdentifier" - } - ], - "required": [ - "kind" - ] - }, - "EntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityRecognitionLROResults" - }, - "CustomEntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomEntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomEntityRecognitionLROResults" - }, - "CustomSingleLabelClassificationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomLabelClassificationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomSingleLabelClassificationLROResults" - }, - "CustomMultiLabelClassificationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomLabelClassificationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomMultiLabelClassificationLROResults" - }, - "EntityLinkingLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntityLinkingResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityLinkingLROResults" - }, - "PiiEntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/PiiResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "PiiEntityRecognitionLROResults" - }, - "ExtractiveSummarizationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/ExtractiveSummarizationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "ExtractiveSummarizationLROResults" - }, - "HealthcareLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/HealthcareResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "HealthcareLROResults" - }, - "SentimentLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/SentimentResponse" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "SentimentAnalysisLROResults" - }, - "KeyPhraseExtractionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/KeyPhraseResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "KeyPhraseExtractionLROResults" - }, - "DocumentResponse": { - "type": "object", - "properties": {} - }, - "DocumentResult": { - "type": "object", - "required": [ - "id", - "warnings" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique, non-empty document identifier." - }, - "warnings": { - "type": "array", - "description": "Warnings encountered while processing document.", - "items": { - "$ref": "#/definitions/DocumentWarning" - } - }, - "statistics": { - "description": "if showStats=true was specified in the request this field will contain information about the document payload.", - "$ref": "#/definitions/DocumentStatistics" - } - } - }, - "DocumentError": { - "type": "object", - "required": [ - "id", - "error" - ], - "properties": { - "id": { - "type": "string", - "description": "Document Id." - }, - "error": { - "type": "object", - "description": "Document Error.", - "$ref": "common.json#/definitions/Error" - } - } - }, - "DocumentWarning": { - "type": "object", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "LongWordsInDocument", - "DocumentTruncated" - ], - "x-ms-enum": { - "name": "WarningCodeValue", - "modelAsString": true - }, - "description": "Error code." - }, - "message": { - "type": "string", - "description": "Warning message." - }, - "targetRef": { - "type": "string", - "description": "A JSON pointer reference indicating the target object." - } - } - }, - "DocumentStatistics": { - "type": "object", - "required": [ - "charactersCount", - "transactionsCount" - ], - "properties": { - "charactersCount": { - "type": "integer", - "format": "int32", - "description": "Number of text elements recognized in the document." - }, - "transactionsCount": { - "type": "integer", - "format": "int32", - "description": "Number of transactions for the document." - } - }, - "description": "if showStats=true was specified in the request this field will contain information about the document payload." - }, - "DocumentRequestStatistics": { - "type": "object", - "required": [ - "documentsCount", - "validDocumentsCount", - "erroneousDocumentsCount" - ], - "properties": { - "documentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of documents submitted in the request." - }, - "validDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." - }, - "erroneousDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/RequestStatistics" - } - ], - "description": "if showStats=true was specified in the request this field will contain information about the document request payload." - }, - "MultiLanguageInput": { - "type": "object", - "description": "Contains an input document to be analyzed by the service.", - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "A unique, non-empty document identifier." - }, - "text": { - "type": "string", - "description": "The input text to process." - }, - "language": { - "type": "string", - "description": "(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." - } - } - }, - "LanguageInput": { - "type": "object", - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique, non-empty document identifier." - }, - "text": { - "type": "string" - }, - "countryHint": { - "type": "string" - } - } - } - }, - "parameters": {} -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/common.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/common.json deleted file mode 100644 index ddd3dd9c53ff..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/common.json +++ /dev/null @@ -1,819 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2022-05-15-preview" - }, - "paths": {}, - "definitions": { - "ErrorResponse": { - "type": "object", - "description": "Error response.", - "additionalProperties": false, - "properties": { - "error": { - "description": "The error object.", - "$ref": "#/definitions/Error" - } - }, - "required": [ - "error" - ] - }, - "Error": { - "type": "object", - "description": "The error object.", - "additionalProperties": true, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/ErrorCode" - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - }, - "target": { - "type": "string", - "description": "The target of the error." - }, - "details": { - "type": "array", - "description": "An array of details about specific errors that led to this reported error.", - "items": { - "$ref": "#/definitions/Error" - } - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "InnerErrorModel": { - "type": "object", - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", - "additionalProperties": false, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/InnerErrorCode" - }, - "message": { - "type": "string", - "description": "Error message." - }, - "details": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Error details." - }, - "target": { - "type": "string", - "description": "Error target." - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "ErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "ErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidArgument", - "Unauthorized", - "Forbidden", - "NotFound", - "ProjectNotFound", - "OperationNotFound", - "AzureCognitiveSearchNotFound", - "AzureCognitiveSearchIndexNotFound", - "TooManyRequests", - "AzureCognitiveSearchThrottling", - "AzureCognitiveSearchIndexLimitReached", - "InternalServerError", - "ServiceUnavailable", - "Timeout", - "QuotaExceeded", - "Conflict", - "Warning" - ] - }, - "InnerErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "InnerErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidParameterValue", - "KnowledgeBaseNotFound", - "AzureCognitiveSearchNotFound", - "AzureCognitiveSearchThrottling", - "ExtractionFailure", - "InvalidRequestBodyFormat", - "EmptyRequest", - "MissingInputDocuments", - "InvalidDocument", - "ModelVersionIncorrect", - "InvalidDocumentBatch", - "UnsupportedLanguageCode", - "InvalidCountryHint" - ] - }, - "Language": { - "type": "string", - "description": "Language of the text records. This is BCP-47 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." - }, - "StringIndexType": { - "type": "string", - "description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.", - "default": "TextElements_v8", - "enum": [ - "TextElements_v8", - "UnicodeCodePoint", - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "TextElements_v8", - "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." - }, - { - "value": "UnicodeCodePoint", - "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." - }, - { - "value": "Utf16CodeUnit", - "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - } - }, - "TaskState": { - "description": "Returns the current state of the task.", - "properties": { - "lastUpdateDateTime": { - "description": "The last updated time in UTC for the task.", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The status of the task at the mentioned last update time.", - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "State" - } - } - }, - "required": [ - "status", - "lastUpdateDateTime" - ], - "type": "object" - }, - "TaskIdentifier": { - "type": "object", - "description": "Base task object.", - "properties": { - "taskName": { - "type": "string" - } - } - }, - "TaskParameters": { - "type": "object", - "description": "Base parameters object for a text analysis task.", - "properties": { - "loggingOptOut": { - "type": "boolean", - "default": false - } - } - }, - "PreBuiltTaskParameters": { - "type": "object", - "description": "Parameters object for a text analysis task using pre-built models.", - "properties": { - "modelVersion": { - "type": "string", - "default": "latest" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - } - ] - }, - "JobState": { - "properties": { - "displayName": { - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "type": "string" - }, - "jobId": { - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { - "enum": [ - "notStarted", - "running", - "succeeded", - "partiallyCompleted", - "failed", - "cancelled", - "cancelling" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "JobState" - } - }, - "errors": { - "items": { - "$ref": "#/definitions/Error" - }, - "type": "array" - }, - "nextLink": { - "type": "string" - } - }, - "required": [ - "jobId", - "lastUpdatedDateTime", - "createdDateTime", - "status" - ] - }, - "JobErrors": { - "properties": { - "errors": { - "items": { - "$ref": "#/definitions/Error" - }, - "type": "array" - } - }, - "type": "object" - }, - "InputError": { - "type": "object", - "description": "Contains details of errors encountered during a job execution.", - "required": [ - "id", - "error" - ], - "properties": { - "id": { - "type": "string", - "description": "The ID of the input." - }, - "error": { - "type": "object", - "description": "Error encountered.", - "$ref": "#/definitions/Error" - } - } - }, - "InputWarning": { - "type": "object", - "description": "Contains details of warnings encountered during a job execution.", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "description": "Warning code." - }, - "message": { - "type": "string", - "description": "Warning message." - }, - "targetRef": { - "type": "string", - "description": "A JSON pointer reference indicating the target object." - } - } - }, - "RequestStatistics": { - "type": "object", - "required": [ - "transactionsCount" - ], - "properties": { - "transactionsCount": { - "type": "integer", - "format": "int64", - "description": "Number of transactions for the request." - } - }, - "additionalProperties": true, - "description": "if showStats=true was specified in the request this field will contain information about the request payload." - }, - "PreBuiltResult": { - "properties": { - "errors": { - "type": "array", - "description": "Errors by document id.", - "items": { - "$ref": "#/definitions/InputError" - } - }, - "statistics": { - "$ref": "#/definitions/RequestStatistics" - }, - "modelVersion": { - "type": "string", - "description": "This field indicates which model is used for scoring." - } - }, - "required": [ - "errors", - "modelVersion" - ] - }, - "AnswersResult": { - "type": "object", - "description": "Represents List of Question Answers.", - "additionalProperties": false, - "properties": { - "answers": { - "type": "array", - "description": "Represents Answer Result list.", - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswer" - } - } - } - }, - "KnowledgeBaseAnswer": { - "type": "object", - "description": "Represents knowledge base answer.", - "additionalProperties": false, - "properties": { - "questions": { - "type": "array", - "description": "List of questions associated with the answer.", - "items": { - "type": "string" - } - }, - "answer": { - "type": "string", - "description": "Answer text." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidence", - "description": "Answer confidence score, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "id": { - "type": "integer", - "x-ms-client-name": "qnaId", - "description": "ID of the QnA result.", - "format": "int32" - }, - "source": { - "type": "string", - "description": "Source of QnA result." - }, - "metadata": { - "type": "object", - "description": "Metadata associated with the answer, useful to categorize or filter question answers.", - "additionalProperties": { - "type": "string" - } - }, - "dialog": { - "type": "object", - "$ref": "#/definitions/KnowledgeBaseAnswerDialog" - }, - "answerSpan": { - "type": "object", - "x-ms-client-name": "shortAnswer", - "description": "Answer span object of QnA with respect to user's question.", - "$ref": "#/definitions/AnswerSpan" - } - } - }, - "KnowledgeBaseAnswerDialog": { - "type": "object", - "description": "Dialog associated with Answer.", - "properties": { - "isContextOnly": { - "type": "boolean", - "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as search result for queries without context; otherwise, if false, ignores context and includes this QnA in search result." - }, - "prompts": { - "type": "array", - "description": "List of prompts associated with the answer.", - "maxItems": 20, - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswerPrompt" - } - } - } - }, - "KnowledgeBaseAnswerPrompt": { - "type": "object", - "description": "Prompt for an answer.", - "properties": { - "displayOrder": { - "type": "integer", - "description": "Index of the prompt - used in ordering of the prompts.", - "format": "int32" - }, - "qnaId": { - "type": "integer", - "description": "QnA ID corresponding to the prompt.", - "format": "int32" - }, - "displayText": { - "type": "string", - "description": "Text displayed to represent a follow up question prompt.", - "maxLength": 200 - } - } - }, - "AnswerSpan": { - "type": "object", - "description": "Answer span object of QnA.", - "additionalProperties": false, - "properties": { - "text": { - "type": "string", - "description": "Predicted text of answer span." - }, - "confidenceScore": { - "type": "number", - "x-ms-client-name": "confidence", - "description": "Predicted score of answer span, value ranges from 0 to 1.", - "format": "double", - "maximum": 1, - "minimum": 0 - }, - "offset": { - "type": "integer", - "description": "The answer span offset from the start of answer.", - "format": "int32" - }, - "length": { - "type": "integer", - "description": "The length of the answer span.", - "format": "int32" - } - } - }, - "AnswersOptions": { - "type": "object", - "description": "Parameters to query a knowledge base.", - "additionalProperties": false, - "properties": { - "qnaId": { - "type": "integer", - "description": "Exact QnA ID to fetch from the knowledge base, this field takes priority over question.", - "format": "int32" - }, - "question": { - "type": "string", - "description": "User question to query against the knowledge base." - }, - "top": { - "type": "integer", - "description": "Max number of answers to be returned for the question.", - "format": "int32" - }, - "userId": { - "type": "string", - "description": "Unique identifier for the user." - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidenceThreshold", - "description": "Minimum threshold score for answers, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "context": { - "x-ms-client-name": "answerContext", - "description": "Context object with previous QnA's information.", - "$ref": "#/definitions/KnowledgeBaseAnswerContext" - }, - "rankerType": { - "type": "string", - "x-ms-client-name": "rankerKind", - "description": "Type of ranker to be used.", - "x-ms-enum": { - "name": "RankerKind", - "modelAsString": true, - "values": [ - { - "value": "QuestionOnly", - "description": "Question only ranker." - }, - { - "value": "Default", - "description": "Default ranker." - } - ] - }, - "enum": [ - "Default", - "QuestionOnly" - ] - }, - "filters": { - "description": "Filter QnAs based on given metadata list and knowledge base sources.", - "$ref": "#/definitions/QueryFilters" - }, - "answerSpanRequest": { - "x-ms-client-name": "shortAnswerOptions", - "description": "To configure Answer span prediction feature.", - "$ref": "#/definitions/ShortAnswerOptions" - }, - "includeUnstructuredSources": { - "type": "boolean", - "description": "(Optional) Flag to enable Query over Unstructured Sources." - } - } - }, - "KnowledgeBaseAnswerContext": { - "type": "object", - "description": "Context object with previous QnA's information.", - "additionalProperties": false, - "required": [ - "previousQnaId" - ], - "properties": { - "previousQnaId": { - "type": "integer", - "description": "Previous turn top answer result QnA ID.", - "format": "int32" - }, - "previousUserQuery": { - "type": "string", - "x-ms-client-name": "previousQuestion", - "description": "Previous user query." - } - } - }, - "QueryFilters": { - "type": "object", - "description": "filters over knowledge base.", - "additionalProperties": false, - "properties": { - "metadataFilter": { - "type": "object", - "$ref": "#/definitions/MetadataFilter" - }, - "sourceFilter": { - "type": "object", - "$ref": "#/definitions/SourceFilter" - }, - "logicalOperation": { - "type": "string", - "description": "Logical operation used to join metadata filter with source filter.", - "$ref": "#/definitions/LogicalOperationKind", - "default": "AND" - } - } - }, - "MetadataFilter": { - "type": "object", - "description": "Find QnAs that are associated with the given list of metadata.", - "additionalProperties": false, - "properties": { - "metadata": { - "type": "array", - "items": { - "$ref": "#/definitions/MetadataRecord" - } - }, - "logicalOperation": { - "type": "string", - "description": "Operation used to join metadata filters.", - "$ref": "#/definitions/LogicalOperationKind", - "default": "AND" - } - } - }, - "MetadataRecord": { - "type": "object", - "description": "Object to provide the key value pair for each metadata.", - "additionalProperties": false, - "required": [ - "key", - "value" - ], - "properties": { - "key": { - "type": "string", - "description": "Metadata Key from Metadata dictionary used in the QnA." - }, - "value": { - "type": "string", - "description": "Metadata Value from Metadata dictionary used in the QnA." - } - } - }, - "SourceFilter": { - "type": "array", - "description": "Find QnAs that are associated with any of the given list of sources in knowledge base.", - "items": { - "type": "string" - } - }, - "LogicalOperationKind": { - "type": "string", - "description": "Set to 'OR' or 'AND' for using corresponding logical operation.", - "x-ms-enum": { - "name": "LogicalOperationKind", - "modelAsString": true - }, - "enum": [ - "AND", - "OR" - ] - }, - "ShortAnswerOptions": { - "type": "object", - "description": "To configure Answer span prediction feature.", - "additionalProperties": false, - "required": [ - "enable" - ], - "properties": { - "enable": { - "type": "boolean", - "description": "Enable or disable Answer Span prediction.", - "enum": [ - true - ], - "x-ms-enum": { - "name": "enable", - "modelAsString": false - } - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidenceThreshold", - "description": "Minimum threshold score required to include an answer span, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "topAnswersWithSpan": { - "type": "integer", - "x-ms-client-name": "top", - "description": "Number of Top answers to be considered for span prediction from 1 to 10.", - "format": "int32", - "maximum": 10, - "minimum": 1 - } - } - } - }, - "parameters": { - "Endpoint": { - "name": "Endpoint", - "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - "ProjectNameQueryParameter": { - "name": "projectName", - "in": "query", - "required": true, - "type": "string", - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "ProjectNamePathParameter": { - "name": "projectName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 100, - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNameQueryParameter": { - "name": "deploymentName", - "in": "query", - "required": true, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNamePathParameter": { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - }, - "TopParameter": { - "name": "top", - "in": "query", - "description": "The maximum number of resources to return from the collection.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "SkipParameter": { - "name": "skip", - "in": "query", - "description": "An offset into the collection of the first resource to be returned.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "MaxPageSizeParameter": { - "name": "maxpagesize", - "in": "query", - "description": "The maximum number of resources to include in a single response.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "ShowStats": { - "name": "showStats", - "in": "query", - "description": "(Optional) if set to true, response will contain request and document level statistics.", - "type": "boolean", - "required": false, - "x-ms-parameter-location": "method" - }, - "JobId": { - "description": "Job ID", - "format": "uuid", - "in": "path", - "name": "jobId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulAnalyzeTextJobsCancelRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulAnalyzeTextJobsCancelRequest.json deleted file mode 100644 index 28a4b3eef607..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulAnalyzeTextJobsCancelRequest.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json deleted file mode 100644 index 2d40cffc07b4..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json +++ /dev/null @@ -1,131 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Extracting Location & US Region", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 2, - "failed": 0, - "inProgress": 0, - "total": 2, - "items": [ - { - "kind": "EntityRecognitionLROResults", - "taskName": "Recognize Entities", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "entities": [ - { - "category": "Event", - "confidenceScore": 0.61, - "length": 4, - "offset": 18, - "text": "trip" - }, - { - "category": "Location", - "confidenceScore": 0.82, - "length": 7, - "offset": 26, - "subcategory": "GPE", - "text": "Seattle" - }, - { - "category": "DateTime", - "confidenceScore": 0.8, - "length": 9, - "offset": 34, - "subcategory": "DateRange", - "text": "last week" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "Location", - "confidenceScore": 0.52, - "length": 3, - "offset": 14, - "subcategory": "GPE", - "text": "NYC" - }, - { - "category": "DateTime", - "confidenceScore": 0.8, - "length": 8, - "offset": 18, - "subcategory": "Date", - "text": "tomorrow" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-04-01" - } - }, - { - "kind": "CustomEntityRecognitionLROResults", - "taskName": "Recognize US Regions", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "entities": [ - { - "category": "USRegion", - "confidenceScore": 0.85, - "length": 17, - "offset": 45, - "text": "Pacific Northwest" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "USRegion", - "confidenceScore": 0.88, - "length": 10, - "offset": 63, - "text": "East Coast" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "projectName": "MyProject", - "deploymentName": "MyDeployment" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json deleted file mode 100644 index 6394385168c5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Extracting Location & US Region", - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "I had a wonderful trip to Seattle last week." - }, - { - "id": "2", - "language": "en", - "text": "I'm flying to NYC tomorrow. See you there." - } - ] - }, - "tasks": [ - { - "kind": "EntityRecognition", - "taskName": "Recognize Entities", - "parameters": { - "modelVersion": "latest" - } - }, - { - "kind": "CustomEntityRecognition", - "taskName": "Recognize US Regions", - "parameters": { - "projectName": "MyProject", - "deploymentName": "MyDeployment" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulEntityLinkingRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulEntityLinkingRequest.json deleted file mode 100644 index a88f2f61663c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulEntityLinkingRequest.json +++ /dev/null @@ -1,128 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "EntityLinking", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Microsoft was founded by Bill Gates and Paul Allen." - }, - { - "id": "2", - "language": "en", - "text": "Pike place market is my favorite Seattle attraction." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "EntityLinkingResults", - "results": { - "documents": [ - { - "entities": [ - { - "dataSource": "Wikipedia", - "id": "Bill Gates", - "language": "en", - "matches": [ - { - "confidenceScore": 0.52, - "length": 10, - "offset": 25, - "text": "Bill Gates" - } - ], - "name": "Bill Gates", - "url": "https://en.wikipedia.org/wiki/Bill_Gates" - }, - { - "dataSource": "Wikipedia", - "id": "Paul Allen", - "language": "en", - "matches": [ - { - "confidenceScore": 0.54, - "length": 10, - "offset": 40, - "text": "Paul Allen" - } - ], - "name": "Paul Allen", - "url": "https://en.wikipedia.org/wiki/Paul_Allen" - }, - { - "dataSource": "Wikipedia", - "id": "Microsoft", - "language": "en", - "matches": [ - { - "confidenceScore": 0.49, - "length": 9, - "offset": 0, - "text": "Microsoft" - } - ], - "name": "Microsoft", - "url": "https://en.wikipedia.org/wiki/Microsoft" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "dataSource": "Wikipedia", - "id": "Pike Place Market", - "language": "en", - "matches": [ - { - "confidenceScore": 0.86, - "length": 17, - "offset": 0, - "text": "Pike place market" - } - ], - "name": "Pike Place Market", - "url": "https://en.wikipedia.org/wiki/Pike_Place_Market" - }, - { - "dataSource": "Wikipedia", - "id": "Seattle", - "language": "en", - "matches": [ - { - "confidenceScore": 0.27, - "length": 7, - "offset": 33, - "text": "Seattle" - } - ], - "name": "Seattle", - "url": "https://en.wikipedia.org/wiki/Seattle" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-02-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulEntityRecognitionRequest.json deleted file mode 100644 index 0870b50fd7e7..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulEntityRecognitionRequest.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "EntityRecognition", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Microsoft was founded by Bill Gates and Paul Allen." - }, - { - "id": "2", - "language": "en", - "text": "Pike place market is my favorite Seattle attraction." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "EntityRecognitionResults", - "results": { - "documents": [ - { - "entities": [ - { - "category": "Organization", - "confidenceScore": 0.84, - "length": 9, - "offset": 0, - "text": "Microsoft" - }, - { - "category": "Person", - "confidenceScore": 0.85, - "length": 10, - "offset": 25, - "text": "Bill Gates" - }, - { - "category": "Person", - "confidenceScore": 0.9, - "length": 10, - "offset": 40, - "text": "Paul Allen" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "Location", - "confidenceScore": 0.55, - "length": 7, - "offset": 33, - "subcategory": "GPE", - "text": "Seattle" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-04-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulKeyPhraseExtractionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulKeyPhraseExtractionRequest.json deleted file mode 100644 index 158017e7150e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulKeyPhraseExtractionRequest.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "KeyPhraseExtraction", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Microsoft was founded by Bill Gates and Paul Allen." - }, - { - "id": "2", - "language": "en", - "text": "Text Analytics is one of the Azure Cognitive Services." - }, - { - "id": "3", - "language": "en", - "text": "My cat might need to see a veterinarian." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "KeyPhraseExtractionResults", - "results": { - "documents": [ - { - "id": "1", - "keyPhrases": [ - "Bill Gates", - "Paul Allen", - "Microsoft" - ], - "warnings": [] - }, - { - "id": "2", - "keyPhrases": [ - "Azure Cognitive Services", - "Text Analytics" - ], - "warnings": [] - }, - { - "id": "3", - "keyPhrases": [ - "cat", - "veterinarian" - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2019-10-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulLanguageDetectionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulLanguageDetectionRequest.json deleted file mode 100644 index a60fe7c4322d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulLanguageDetectionRequest.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "LanguageDetection", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "text": "Hello world" - }, - { - "id": "2", - "text": "Bonjour tout le monde" - }, - { - "id": "3", - "text": "Hola mundo" - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "LanguageDetectionResults", - "results": { - "documents": [ - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "en", - "name": "English" - }, - "id": "1", - "warnings": [] - }, - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "fr", - "name": "French" - }, - "id": "2", - "warnings": [] - }, - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "es", - "name": "Spanish" - }, - "id": "3", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-04-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulPiiEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulPiiEntityRecognitionRequest.json deleted file mode 100644 index 60453741e8d0..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulPiiEntityRecognitionRequest.json +++ /dev/null @@ -1,88 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "PiiEntityRecognition", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "My SSN is 859-98-0987" - }, - { - "id": "2", - "language": "en", - "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." - }, - { - "id": "3", - "language": "en", - "text": "Is 998.214.865-68 your Brazilian CPF number?" - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "PiiEntityRecognitionResults", - "results": { - "documents": [ - { - "id": "1", - "redactedText": "My SSN is ***********", - "entities": [ - { - "category": "U.S. Social Security Number (SSN)", - "confidenceScore": 0.65, - "length": 11, - "offset": 28, - "text": "859-98-0987" - } - ], - "warnings": [] - }, - { - "id": "2", - "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", - "entities": [ - { - "category": "ABA Routing Number", - "confidenceScore": 0.75, - "length": 9, - "offset": 18, - "text": "111000025" - } - ], - "warnings": [] - }, - { - "id": "3", - "redactedText": "Is ************** your Brazilian CPF number?", - "entities": [ - { - "category": "Brazil CPF Number", - "confidenceScore": 0.85, - "length": 14, - "offset": 3, - "text": "998.214.865-68" - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2019-10-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulSentimentAnalysisRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulSentimentAnalysisRequest.json deleted file mode 100644 index 0b2906cbad7c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/SuccessfulSentimentAnalysisRequest.json +++ /dev/null @@ -1,148 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "SentimentAnalysis", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "SentimentAnalysisResults", - "results": { - "documents": [ - { - "confidenceScores": { - "negative": 0, - "neutral": 0, - "positive": 1 - }, - "id": "1", - "sentences": [ - { - "targets": [ - { - "confidenceScores": { - "negative": 0, - "positive": 1 - }, - "length": 10, - "offset": 6, - "relations": [ - { - "ref": "#/documents/0/sentences/0/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "atmosphere" - } - ], - "confidenceScores": { - "negative": 0, - "neutral": 0, - "positive": 1 - }, - "length": 17, - "offset": 0, - "assessments": [ - { - "confidenceScores": { - "negative": 0, - "positive": 1 - }, - "isNegated": false, - "length": 5, - "offset": 0, - "sentiment": "positive", - "text": "great" - } - ], - "sentiment": "positive", - "text": "Great atmosphere." - }, - { - "targets": [ - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "length": 11, - "offset": 37, - "relations": [ - { - "ref": "#/documents/0/sentences/1/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "restaurants" - }, - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "length": 6, - "offset": 50, - "relations": [ - { - "ref": "#/documents/0/sentences/1/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "hotels" - } - ], - "confidenceScores": { - "negative": 0.01, - "neutral": 0.86, - "positive": 0.13 - }, - "length": 52, - "offset": 18, - "assessments": [ - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "isNegated": false, - "length": 15, - "offset": 18, - "sentiment": "positive", - "text": "Close to plenty" - } - ], - "sentiment": "neutral", - "text": "Close to plenty of restaurants, hotels, and transit!" - } - ], - "sentiment": "positive", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-04-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json deleted file mode 100644 index 29c29461a2ce..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json deleted file mode 100644 index 4a063c94d39f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/merge-patch+json", - "api-version": "2022-05-15-preview", - "projectName": "myproject", - "body": { - "projectName": "myproject", - "language": "en", - "projectKind": "Conversation", - "description": "This is a sample conversation project.", - "multilingual": false - } - }, - "responses": { - "201": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "projectKind": "Conversation", - "projectName": "myproject", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - } - }, - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "Conversation", - "projectName": "myproject", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json deleted file mode 100644 index 637ac0cfde5e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp", - "deploymentName": "staging" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json deleted file mode 100644 index 9f764cbc3a42..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model2" - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json deleted file mode 100644 index cfe5a774ab4b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "myproject" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json deleted file mode 100644 index 01089a13276e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp", - "deploymentName": "production", - "body": { - "trainedModelLabel": "model1" - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json deleted file mode 100644 index 4f77caddb2d7..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp", - "stringIndexType": "Utf16CodeUnit" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json deleted file mode 100644 index 71769214638b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp", - "deploymentName": "staging" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "deploymentName": "staging", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T15:53:04Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json deleted file mode 100644 index f2e68929757f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp", - "deploymentName": "production", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json deleted file mode 100644 index 8ba1c9d1943f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp", - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "resultUrl": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2022-05-15-preview", - "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", - "createdDateTime": "2022-04-18T15:23:07Z", - "lastUpdatedDateTime": "2022-04-18T15:23:08Z", - "expirationDateTime": "2022-04-25T15:23:07Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json deleted file mode 100644 index ddfe9be9da93..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp", - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", - "createdDateTime": "2022-04-18T15:17:20Z", - "lastUpdatedDateTime": "2022-04-18T15:17:22Z", - "expirationDateTime": "2022-04-25T15:17:20Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json deleted file mode 100644 index 49381b74c207..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "label": "model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49Z", - "lastTrainingDurationInSeconds": 186, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json deleted file mode 100644 index 1d361fa2e4cb..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json +++ /dev/null @@ -1,284 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1", - "stringIndexType": "Utf16CodeUnit", - "maxpagesize": 10 - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "text": "send the email", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [], - "predictedEntities": [] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "send a mail to daniel", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 15, - "length": 6 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 15, - "length": 6 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "i forgot to add an important part to that email to james . please set it up to edit", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 51, - "length": 5 - } - ], - "predictedEntities": [ - { - "category": "Category", - "offset": 19, - "length": 9 - }, - { - "category": "ContactName", - "offset": 51, - "length": 5 - } - ] - }, - "intentsResult": { - "expectedIntent": "AddMore", - "predictedIntent": "AddMore" - } - }, - { - "text": "send email to a and tian", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 14, - "length": 1 - }, - { - "category": "ContactName", - "offset": 20, - "length": 4 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 14, - "length": 1 - }, - { - "category": "ContactName", - "offset": 20, - "length": 4 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "send thomas an email", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 5, - "length": 6 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 5, - "length": 6 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "i need to add more to the email message i am sending to vincent", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 56, - "length": 7 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 56, - "length": 7 - } - ] - }, - "intentsResult": { - "expectedIntent": "AddMore", - "predictedIntent": "AddMore" - } - }, - { - "text": "send an email to lily roth and abc123@microsoft.com", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 17, - "length": 9 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 17, - "length": 9 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "i need to add something else to my email to cheryl", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 44, - "length": 6 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 44, - "length": 6 - } - ] - }, - "intentsResult": { - "expectedIntent": "AddMore", - "predictedIntent": "AddMore" - } - }, - { - "text": "send an email to larry , joseph and billy larkson", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 17, - "length": 5 - }, - { - "category": "ContactName", - "offset": 25, - "length": 6 - }, - { - "category": "ContactName", - "offset": 36, - "length": 13 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 17, - "length": 5 - }, - { - "category": "ContactName", - "offset": 25, - "length": 6 - }, - { - "category": "ContactName", - "offset": 36, - "length": 13 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "send mail to dorothy", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 13, - "length": 7 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 13, - "length": 7 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - } - ], - "nextLink": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2022-05-15-preview&top=2147483637&skip=10&maxpagesize=10" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json deleted file mode 100644 index 29b8c6268fc3..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json +++ /dev/null @@ -1,526 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "entitiesEvaluation": { - "confusionMatrix": { - "Attachment": { - "Attachment": { - "normalizedValue": 100.0, - "rawValue": 3.0 - } - }, - "Category": { - "Category": { - "normalizedValue": 91.666664, - "rawValue": 11.0 - }, - "$none": { - "normalizedValue": 8.333333, - "rawValue": 1.0 - } - }, - "ContactName": { - "ContactName": { - "normalizedValue": 91.666664, - "rawValue": 22.0 - }, - "SenderName": { - "normalizedValue": 4.1666665, - "rawValue": 1.0 - }, - "$none": { - "normalizedValue": 4.1666665, - "rawValue": 1.0 - } - }, - "Date": { - "Date": { - "normalizedValue": 100.0, - "rawValue": 2.0 - } - }, - "EmailSubject": { - "EmailSubject": { - "normalizedValue": 93.33333, - "rawValue": 9.333334 - }, - "$none": { - "normalizedValue": 6.6666665, - "rawValue": 0.6666667 - } - }, - "FromRelationshipName": { - "FromRelationshipName": { - "normalizedValue": 100.0, - "rawValue": 1.0 - } - }, - "Line": { - "Line": { - "normalizedValue": 100.0, - "rawValue": 2.0 - } - }, - "Message": { - "Message": { - "normalizedValue": 81.2063, - "rawValue": 6.496504 - }, - "EmailSubject": { - "normalizedValue": 7.43007, - "rawValue": 0.5944056 - }, - "$none": { - "normalizedValue": 9.120047, - "rawValue": 0.7296037 - }, - "Date": { - "normalizedValue": 2.2435899, - "rawValue": 0.17948718 - } - }, - "OrderReference": { - "OrderReference": { - "normalizedValue": 100.0, - "rawValue": 17.0 - } - }, - "PositionReference": { - "$none": { - "normalizedValue": 100.0, - "rawValue": 1.0 - } - }, - "RelationshipName": { - "RelationshipName": { - "normalizedValue": 66.666664, - "rawValue": 2.0 - }, - "$none": { - "normalizedValue": 33.333332, - "rawValue": 1.0 - } - }, - "SearchTexts": { - "SearchTexts": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "SenderName": { - "SenderName": { - "normalizedValue": 88.888885, - "rawValue": 8.0 - }, - "ContactName": { - "normalizedValue": 11.111111, - "rawValue": 1.0 - } - }, - "Time": { - "$none": { - "normalizedValue": 100.0, - "rawValue": 2.0 - } - }, - "$none": { - "$none": { - "normalizedValue": 99.739265, - "rawValue": 162.575 - }, - "Category": { - "normalizedValue": 0.2607362, - "rawValue": 0.425 - } - } - }, - "entities": { - "ContactName": { - "f1": 0.9361702799797058, - "precision": 0.95652174949646, - "recall": 0.9166666865348816, - "truePositiveCount": 22, - "trueNegativeCount": 0, - "falsePositiveCount": 1, - "falseNegativeCount": 2 - }, - "Category": { - "f1": 0.8799999952316284, - "precision": 0.8461538553237915, - "recall": 0.9166666865348816, - "truePositiveCount": 11, - "trueNegativeCount": 0, - "falsePositiveCount": 2, - "falseNegativeCount": 1 - }, - "SenderName": { - "f1": 0.8888888955116272, - "precision": 0.8888888955116272, - "recall": 0.8888888955116272, - "truePositiveCount": 8, - "trueNegativeCount": 0, - "falsePositiveCount": 1, - "falseNegativeCount": 1 - }, - "EmailSubject": { - "f1": 0.8181817531585693, - "precision": 0.75, - "recall": 0.8999999761581421, - "truePositiveCount": 9, - "trueNegativeCount": 0, - "falsePositiveCount": 3, - "falseNegativeCount": 1 - }, - "Message": { - "f1": 0.75, - "precision": 0.75, - "recall": 0.75, - "truePositiveCount": 6, - "trueNegativeCount": 0, - "falsePositiveCount": 2, - "falseNegativeCount": 2 - }, - "Date": { - "f1": 0.800000011920929, - "precision": 0.6666666865348816, - "recall": 1.0, - "truePositiveCount": 2, - "trueNegativeCount": 0, - "falsePositiveCount": 1, - "falseNegativeCount": 0 - }, - "OrderReference": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 17, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "SearchTexts": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Attachment": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 3, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "RelationshipName": { - "f1": 0.800000011920929, - "precision": 1.0, - "recall": 0.6666666865348816, - "truePositiveCount": 2, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 1 - }, - "Line": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 2, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Time": { - "f1": 0.0, - "precision": 0.0, - "recall": 0.0, - "truePositiveCount": 0, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 2 - }, - "FromRelationshipName": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 1, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "PositionReference": { - "f1": 0.0, - "precision": 0.0, - "recall": 0.0, - "truePositiveCount": 0, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 1 - } - }, - "microF1": 0.8923077, - "microPrecision": 0.8969072, - "microRecall": 0.8877551, - "macroF1": 0.7766601, - "macroPrecision": 0.7755879, - "macroRecall": 0.78849214 - }, - "intentsEvaluation": { - "confusionMatrix": { - "AddFlag": { - "AddFlag": { - "normalizedValue": 100.0, - "rawValue": 6.0 - } - }, - "AddMore": { - "AddMore": { - "normalizedValue": 100.0, - "rawValue": 17.0 - } - }, - "Cancel": { - "Cancel": { - "normalizedValue": 100.0, - "rawValue": 9.0 - } - }, - "CheckMessages": { - "CheckMessages": { - "normalizedValue": 100.0, - "rawValue": 9.0 - } - }, - "Confirm": { - "Confirm": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "Delete": { - "Delete": { - "normalizedValue": 100.0, - "rawValue": 5.0 - } - }, - "Forward": { - "Forward": { - "normalizedValue": 100.0, - "rawValue": 6.0 - } - }, - "None": { - "None": { - "normalizedValue": 100.0, - "rawValue": 1.0 - } - }, - "QueryLastText": { - "QueryLastText": { - "normalizedValue": 100.0, - "rawValue": 6.0 - } - }, - "ReadAloud": { - "ReadAloud": { - "normalizedValue": 100.0, - "rawValue": 16.0 - } - }, - "Reply": { - "Reply": { - "normalizedValue": 100.0, - "rawValue": 6.0 - } - }, - "SearchMessages": { - "SearchMessages": { - "normalizedValue": 100.0, - "rawValue": 9.0 - } - }, - "SendEmail": { - "SendEmail": { - "normalizedValue": 100.0, - "rawValue": 20.0 - } - }, - "ShowNext": { - "ShowNext": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "ShowPrevious": { - "ShowPrevious": { - "normalizedValue": 100.0, - "rawValue": 3.0 - } - } - }, - "intents": { - "AddMore": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 17, - "trueNegativeCount": 104, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Cancel": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 9, - "trueNegativeCount": 112, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "SendEmail": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 20, - "trueNegativeCount": 101, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "CheckMessages": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 9, - "trueNegativeCount": 112, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "AddFlag": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 6, - "trueNegativeCount": 115, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Reply": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 6, - "trueNegativeCount": 115, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "ReadAloud": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 16, - "trueNegativeCount": 105, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "QueryLastText": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 6, - "trueNegativeCount": 115, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "SearchMessages": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 9, - "trueNegativeCount": 112, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Delete": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 5, - "trueNegativeCount": 116, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Forward": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 6, - "trueNegativeCount": 115, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Confirm": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 117, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "ShowNext": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 117, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "ShowPrevious": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 3, - "trueNegativeCount": 118, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "None": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 1, - "trueNegativeCount": 120, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - } - }, - "microF1": 1.0, - "microPrecision": 1.0, - "microRecall": 1.0, - "macroF1": 1.0, - "macroPrecision": 1.0, - "macroRecall": 1.0 - }, - "evaluationOptions": { - "kind": "percentage", - "trainingSplitPercentage": 80, - "testingSplitPercentage": 20 - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json deleted file mode 100644 index 7ea2778534cd..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "myproject" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "Conversation", - "projectName": "myproject", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json deleted file mode 100644 index aab8c6504e79..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000", - "createdDateTime": "2022-04-18T14:02:34Z", - "lastUpdatedDateTime": "2022-04-18T14:02:34Z", - "expirationDateTime": "2022-04-25T14:02:34Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json deleted file mode 100644 index ac1c0db5aa92..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json +++ /dev/null @@ -1,398 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectKind": "Conversation" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "languageName": "English", - "languageCode": "en" - }, - { - "languageName": "English", - "languageCode": "en-us" - }, - { - "languageName": "English (UK)", - "languageCode": "en-gb" - }, - { - "languageName": "French", - "languageCode": "fr" - }, - { - "languageName": "Italian", - "languageCode": "it" - }, - { - "languageName": "Spanish", - "languageCode": "es" - }, - { - "languageName": "German", - "languageCode": "de" - }, - { - "languageName": "Portuguese (Brazil)", - "languageCode": "pt-br" - }, - { - "languageName": "Portuguese (Portugal)", - "languageCode": "pt-pt" - }, - { - "languageName": "Chinese (Simplified)", - "languageCode": "zh-hans" - }, - { - "languageName": "Japanese", - "languageCode": "ja" - }, - { - "languageName": "Korean", - "languageCode": "ko" - }, - { - "languageName": "Dutch", - "languageCode": "nl" - }, - { - "languageName": "Hindi", - "languageCode": "hi" - }, - { - "languageName": "Turkish", - "languageCode": "tr" - }, - { - "languageName": "Gujarati", - "languageCode": "gu" - }, - { - "languageName": "Marathi", - "languageCode": "mr" - }, - { - "languageName": "Tamil", - "languageCode": "ta" - }, - { - "languageName": "Telugu", - "languageCode": "te" - }, - { - "languageName": "Zulu", - "languageCode": "zu" - }, - { - "languageName": "Afrikaans", - "languageCode": "af" - }, - { - "languageName": "Amharic", - "languageCode": "am" - }, - { - "languageName": "Arabic", - "languageCode": "ar" - }, - { - "languageName": "Assamese", - "languageCode": "as" - }, - { - "languageName": "Azerbaijani", - "languageCode": "az" - }, - { - "languageName": "Belarusian", - "languageCode": "be" - }, - { - "languageName": "Bulgarian", - "languageCode": "bg" - }, - { - "languageName": "Breton", - "languageCode": "br" - }, - { - "languageName": "Bosnian", - "languageCode": "bs" - }, - { - "languageName": "Catalan", - "languageCode": "ca" - }, - { - "languageName": "Czech", - "languageCode": "cs" - }, - { - "languageName": "Welsh", - "languageCode": "cy" - }, - { - "languageName": "Danish", - "languageCode": "da" - }, - { - "languageName": "Greek", - "languageCode": "el" - }, - { - "languageName": "Esperanto", - "languageCode": "eo" - }, - { - "languageName": "Estonian", - "languageCode": "et" - }, - { - "languageName": "Basque", - "languageCode": "eu" - }, - { - "languageName": "Persian", - "languageCode": "fa" - }, - { - "languageName": "Finnish", - "languageCode": "fi" - }, - { - "languageName": "Western Frisian", - "languageCode": "fy" - }, - { - "languageName": "Irish", - "languageCode": "ga" - }, - { - "languageName": "Scottish Gaelic", - "languageCode": "gd" - }, - { - "languageName": "Galician", - "languageCode": "gl" - }, - { - "languageName": "Hausa", - "languageCode": "ha" - }, - { - "languageName": "Hebrew", - "languageCode": "he" - }, - { - "languageName": "Croatian", - "languageCode": "hr" - }, - { - "languageName": "Hungarian", - "languageCode": "hu" - }, - { - "languageName": "Armenian", - "languageCode": "hy" - }, - { - "languageName": "Indonesian", - "languageCode": "id" - }, - { - "languageName": "Javanese", - "languageCode": "jv" - }, - { - "languageName": "Georgian", - "languageCode": "ka" - }, - { - "languageName": "Kazakh", - "languageCode": "kk" - }, - { - "languageName": "Khmer", - "languageCode": "km" - }, - { - "languageName": "Kannada", - "languageCode": "kn" - }, - { - "languageName": "Kurdish (Kurmanji)", - "languageCode": "ku" - }, - { - "languageName": "Kyrgyz", - "languageCode": "ky" - }, - { - "languageName": "Latin", - "languageCode": "la" - }, - { - "languageName": "Lao", - "languageCode": "lo" - }, - { - "languageName": "Lithuanian", - "languageCode": "lt" - }, - { - "languageName": "Latvian", - "languageCode": "lv" - }, - { - "languageName": "Malagasy", - "languageCode": "mg" - }, - { - "languageName": "Macedonian", - "languageCode": "mk" - }, - { - "languageName": "Malayalam", - "languageCode": "ml" - }, - { - "languageName": "Mongolian", - "languageCode": "mn" - }, - { - "languageName": "Malay", - "languageCode": "ms" - }, - { - "languageName": "Burmese", - "languageCode": "my" - }, - { - "languageName": "Nepali", - "languageCode": "ne" - }, - { - "languageName": "Norwegian (Bokmal)", - "languageCode": "nb" - }, - { - "languageName": "Odia", - "languageCode": "or" - }, - { - "languageName": "Punjabi", - "languageCode": "pa" - }, - { - "languageName": "Polish", - "languageCode": "pl" - }, - { - "languageName": "Pashto", - "languageCode": "ps" - }, - { - "languageName": "Romanian", - "languageCode": "ro" - }, - { - "languageName": "Russian", - "languageCode": "ru" - }, - { - "languageName": "Sanskrit", - "languageCode": "sa" - }, - { - "languageName": "Sindhi", - "languageCode": "sd" - }, - { - "languageName": "Sinhala", - "languageCode": "si" - }, - { - "languageName": "Slovak", - "languageCode": "sk" - }, - { - "languageName": "Slovenian", - "languageCode": "sl" - }, - { - "languageName": "Somali", - "languageCode": "so" - }, - { - "languageName": "Albanian", - "languageCode": "sq" - }, - { - "languageName": "Serbian", - "languageCode": "sr" - }, - { - "languageName": "Sundanese", - "languageCode": "su" - }, - { - "languageName": "Swedish", - "languageCode": "sv" - }, - { - "languageName": "Swahili", - "languageCode": "sw" - }, - { - "languageName": "Thai", - "languageCode": "th" - }, - { - "languageName": "Filipino", - "languageCode": "tl" - }, - { - "languageName": "Uyghur", - "languageCode": "ug" - }, - { - "languageName": "Ukrainian", - "languageCode": "uk" - }, - { - "languageName": "Urdu", - "languageCode": "ur" - }, - { - "languageName": "Uzbek", - "languageCode": "uz" - }, - { - "languageName": "Vietnamese", - "languageCode": "vi" - }, - { - "languageName": "Xhosa", - "languageCode": "xh" - }, - { - "languageName": "Yiddish", - "languageCode": "yi" - }, - { - "languageName": "Chinese (Traditional)", - "languageCode": "zh-hant" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json deleted file mode 100644 index 9c528471f4bc..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json +++ /dev/null @@ -1,98 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "language": "en" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "category": "Person.Name", - "description": "Name of an individual", - "examples": "john, Sam, Lisa" - }, - { - "category": "General.Event", - "description": "Important events", - "examples": "World War two, Covid 19" - }, - { - "category": "General.Organization", - "description": "Companies and corporations", - "examples": "Microsoft, Amazon" - }, - { - "category": "Choice.Boolean", - "description": "boolean choice", - "examples": "yes, no, agreed" - }, - { - "category": "Quantity.Age", - "description": "Age of a person or thing", - "examples": "10-month-old, 19 years old, 58 year-old" - }, - { - "category": "Quantity.NumberRange", - "description": "a numeric interval", - "examples": "between 25 and 35, 25-35" - }, - { - "category": "Quantity.Number", - "description": "A cardinal number in numeric or text form", - "examples": "ten, forty two, 3.141, 10K" - }, - { - "category": "Quantity.Percentage", - "description": "A percentage, using the symbol % or the word \"percent\"", - "examples": "10%, 5.6 percent" - }, - { - "category": "Quantity.Ordinal", - "description": "An ordinal number in numeric or text form", - "examples": "first, second, tenth, 1st, 2nd, 10th" - }, - { - "category": "Quantity.Dimension", - "description": "Spacial dimensions, including length, distance, area, and volume", - "examples": "2 miles, 650 square kilometres, 9,350 feet" - }, - { - "category": "Quantity.Temperature", - "description": "A temperature in celsius or fahrenheit", - "examples": "32F, 34 degrees celsius, 2 deg C" - }, - { - "category": "Quantity.Currency", - "description": "Monetary amounts, including currency", - "examples": "1000.00 US dollars, £20.00, $ 67.5 B" - }, - { - "category": "DateTime", - "description": "exact date values", - "examples": "May 11th" - }, - { - "category": "Email", - "description": "Email addresses", - "examples": "user@example.net, user_name@example.com, user.Name12@example.net" - }, - { - "category": "Phone Number", - "description": "US phone numbers", - "examples": "123-456-7890, +1 123 456 789, (123)456-789" - }, - { - "category": "URL", - "description": "Websites URLs and links", - "examples": "www.example.com, http://example.net?name=my_name&age=10" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json deleted file mode 100644 index 9b7cfd97910b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectKind": "Conversation" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "trainingConfigVersion": "2022-05-01", - "modelExpirationDate": "2022-10-28" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json deleted file mode 100644 index f1759d6378c1..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp", - "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", - "createdDateTime": "2022-04-18T16:09:50Z", - "lastUpdatedDateTime": "2022-04-18T16:09:58Z", - "expirationDateTime": "2022-04-25T16:09:50Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json deleted file mode 100644 index c17872534ff2..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "result": { - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "trainingMode": "standard", - "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", - "trainingStatus": { - "percentComplete": 3, - "startDateTime": "2022-04-18T15:45:06.8190649Z", - "status": "running" - }, - "evaluationStatus": { - "percentComplete": 0, - "status": "notStarted" - } - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:45:48Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "running" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json deleted file mode 100644 index 90674b4ac212..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp", - "body": { - "projectFileVersion": "2022-05-01", - "stringIndexType": "Utf16CodeUnit", - "metadata": { - "projectKind": "Conversation", - "settings": { - "confidenceThreshold": 0.7 - }, - "projectName": "EmailApp", - "multilingual": true, - "description": "Trying out CLU", - "language": "en-us" - }, - "assets": { - "projectKind": "Conversation", - "intents": [ - { - "category": "Read" - }, - { - "category": "Delete" - } - ], - "entities": [ - { - "category": "Sender" - } - ], - "utterances": [ - { - "text": "Open Blake's email", - "dataset": "Train", - "intent": "Read", - "entities": [ - { - "category": "Sender", - "offset": 5, - "length": 5 - } - ] - }, - { - "text": "Delete last email", - "language": "en-gb", - "dataset": "Test", - "intent": "Delete", - "entities": [] - } - ] - } - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json deleted file mode 100644 index fbd93cb8ab0a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "deploymentName": "production", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T16:03:51Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01" - }, - { - "deploymentName": "staging", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T15:53:04Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json deleted file mode 100644 index b1e7042db2a4..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "label": "model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49Z", - "lastTrainingDurationInSeconds": 186, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01" - }, - { - "label": "model2", - "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", - "lastTrainedDateTime": "2022-04-18T17:25:22Z", - "lastTrainingDurationInSeconds": 192, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json deleted file mode 100644 index 3e22b64a797f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "createdDateTime": "2022-04-18T14:03:16Z", - "lastModifiedDateTime": "2022-04-18T14:03:16Z", - "projectKind": "Conversation", - "projectName": "myproject1", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - }, - { - "createdDateTime": "2022-04-18T14:03:12Z", - "lastModifiedDateTime": "2022-04-18T14:03:12Z", - "projectKind": "Conversation", - "projectName": "myproject", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json deleted file mode 100644 index 41832f9ce975..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json +++ /dev/null @@ -1,90 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "result": { - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "trainingMode": "advanced", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T15:45:06.8190649Z", - "endDateTime": "2022-04-18T15:47:19.2639682Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T15:47:19.2734976Z", - "endDateTime": "2022-04-18T15:47:23.8378892Z", - "status": "succeeded" - } - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:47:50Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "succeeded" - }, - { - "result": { - "modelLabel": "model2", - "trainingConfigVersion": "2022-05-01", - "trainingMode": "standard", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:22:39.3663023Z", - "endDateTime": "2022-04-18T17:24:51.9440947Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:24:51.9571747Z", - "endDateTime": "2022-04-18T17:24:58.1427823Z", - "status": "succeeded" - } - }, - "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", - "createdDateTime": "2022-04-18T17:22:11Z", - "lastUpdatedDateTime": "2022-04-18T17:25:23Z", - "expirationDateTime": "2022-04-25T17:22:11Z", - "status": "succeeded" - }, - { - "result": { - "modelLabel": "model2", - "trainingConfigVersion": "2022-05-01", - "trainingMode": "standard", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:44:41.388358Z", - "endDateTime": "2022-04-18T17:50:29.5675101Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:50:29.5808461Z", - "endDateTime": "2022-04-18T17:50:35.3482185Z", - "status": "succeeded" - } - }, - "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", - "createdDateTime": "2022-04-18T17:44:04Z", - "lastUpdatedDateTime": "2022-04-18T17:51:11Z", - "expirationDateTime": "2022-04-25T17:44:04Z", - "status": "succeeded" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json deleted file mode 100644 index 5dd31fbe0561..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp", - "body": { - "firstDeploymentName": "production", - "secondDeploymentName": "staging" - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json deleted file mode 100644 index b11165ff2617..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "EmailApp", - "body": { - "modelLabel": "model1", - "trainingMode": "standard", - "trainingConfigVersion": "latest", - "evaluationOptions": { - "kind": "percentage", - "testingSplitPercentage": 20, - "trainingSplitPercentage": 80 - } - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json deleted file mode 100644 index c58e67ba529e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulCreateProject.json deleted file mode 100644 index f924a9903a54..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulCreateProject.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/merge-patch+json", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "body": { - "projectName": "LoanAgreements", - "language": "en", - "projectKind": "CustomEntityRecognition", - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "multilingual": false, - "storageInputContainerName": "loanagreements" - } - }, - "responses": { - "201": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - } - }, - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json deleted file mode 100644 index 7464c153f291..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "deploymentName": "staging" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/staging/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulDeleteModel.json deleted file mode 100644 index a048be8127b5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulDeleteModel.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model2" - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulDeleteProject.json deleted file mode 100644 index 28ddc40dc9dc..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulDeleteProject.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulDeployProject.json deleted file mode 100644 index 534a5f5c9fde..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulDeployProject.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "deploymentName": "production", - "body": { - "trainedModelLabel": "model1" - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulExportProject.json deleted file mode 100644 index 3350c496b6b2..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulExportProject.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "stringIndexType": "Utf16CodeUnit" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetDeployment.json deleted file mode 100644 index 8fe7d9ed2647..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetDeployment.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "deploymentName": "staging" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "deploymentName": "staging", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T15:53:04Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json deleted file mode 100644 index d0ef2bcd4b81..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "deploymentName": "production", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetExportStatus.json deleted file mode 100644 index 5544327dd087..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetExportStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "resultUrl": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2022-05-15-preview", - "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", - "createdDateTime": "2022-04-18T15:23:07Z", - "lastUpdatedDateTime": "2022-04-18T15:23:08Z", - "expirationDateTime": "2022-04-25T15:23:07Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetImportStatus.json deleted file mode 100644 index d4bf7ab1dbcb..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetImportStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", - "createdDateTime": "2022-04-18T15:17:20Z", - "lastUpdatedDateTime": "2022-04-18T15:17:22Z", - "expirationDateTime": "2022-04-25T15:17:20Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetModel.json deleted file mode 100644 index a7688c7eba23..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetModel.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "label": "model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49Z", - "lastTrainingDurationInSeconds": 186, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json deleted file mode 100644 index 9843b36931ea..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json +++ /dev/null @@ -1,295 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model2", - "stringIndexType": "Utf16CodeUnit", - "maxpagesize": 10 - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "location": "11.txt", - "language": "en-us", - "projectKind": "CustomEntityRecognition", - "customEntityRecognitionResult": { - "entities": [ - { - "expectedEntities": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "BorrowerName", - "offset": 160, - "length": 13 - }, - { - "category": "BorrowerAddress", - "offset": 181, - "length": 34 - }, - { - "category": "BorrowerCity", - "offset": 225, - "length": 6 - }, - { - "category": "BorrowerState", - "offset": 242, - "length": 8 - }, - { - "category": "LenderName", - "offset": 271, - "length": 12 - }, - { - "category": "LenderAddress", - "offset": 310, - "length": 20 - }, - { - "category": "LenderCity", - "offset": 340, - "length": 8 - }, - { - "category": "LenderState", - "offset": 359, - "length": 11 - }, - { - "category": "LoanAmountWords", - "offset": 448, - "length": 52 - }, - { - "category": "LoanAmountNumbers", - "offset": 502, - "length": 10 - }, - { - "category": "Interest", - "offset": 588, - "length": 2 - } - ], - "predictedEntities": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "BorrowerName", - "offset": 160, - "length": 13 - }, - { - "category": "BorrowerAddress", - "offset": 200, - "length": 15 - }, - { - "category": "BorrowerCity", - "offset": 225, - "length": 6 - }, - { - "category": "BorrowerState", - "offset": 242, - "length": 8 - }, - { - "category": "LenderName", - "offset": 271, - "length": 12 - }, - { - "category": "LenderAddress", - "offset": 310, - "length": 20 - }, - { - "category": "LenderCity", - "offset": 340, - "length": 8 - }, - { - "category": "LenderState", - "offset": 359, - "length": 11 - }, - { - "category": "LoanAmountWords", - "offset": 448, - "length": 52 - }, - { - "category": "LoanAmountNumbers", - "offset": 502, - "length": 10 - }, - { - "category": "Interest", - "offset": 588, - "length": 2 - } - ], - "regionOffset": 0, - "regionLength": 1780 - } - ] - } - }, - { - "location": "01.txt", - "language": "en-us", - "projectKind": "CustomEntityRecognition", - "customEntityRecognitionResult": { - "entities": [ - { - "expectedEntities": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "BorrowerName", - "offset": 160, - "length": 13 - }, - { - "category": "BorrowerAddress", - "offset": 200, - "length": 13 - }, - { - "category": "BorrowerCity", - "offset": 223, - "length": 9 - }, - { - "category": "BorrowerState", - "offset": 243, - "length": 8 - }, - { - "category": "LenderName", - "offset": 273, - "length": 14 - }, - { - "category": "LenderAddress", - "offset": 314, - "length": 15 - }, - { - "category": "LenderCity", - "offset": 339, - "length": 10 - }, - { - "category": "LenderState", - "offset": 360, - "length": 8 - }, - { - "category": "LoanAmountWords", - "offset": 446, - "length": 66 - }, - { - "category": "LoanAmountNumbers", - "offset": 514, - "length": 11 - }, - { - "category": "Interest", - "offset": 601, - "length": 2 - } - ], - "predictedEntities": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "BorrowerName", - "offset": 160, - "length": 13 - }, - { - "category": "BorrowerAddress", - "offset": 200, - "length": 13 - }, - { - "category": "BorrowerCity", - "offset": 223, - "length": 9 - }, - { - "category": "BorrowerState", - "offset": 243, - "length": 8 - }, - { - "category": "LenderName", - "offset": 273, - "length": 14 - }, - { - "category": "LenderAddress", - "offset": 314, - "length": 15 - }, - { - "category": "LenderCity", - "offset": 339, - "length": 10 - }, - { - "category": "LenderState", - "offset": 360, - "length": 8 - }, - { - "category": "LoanAmountWords", - "offset": 446, - "length": 66 - }, - { - "category": "LoanAmountNumbers", - "offset": 514, - "length": 11 - }, - { - "category": "Interest", - "offset": 601, - "length": 2 - } - ], - "regionOffset": 0, - "regionLength": 1793 - } - ] - } - } - ], - "nextLink": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/models/model2/evaluation/result/?api-version=2022-05-15-preview&top=2147483645&skip=2&maxpagesize=2" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json deleted file mode 100644 index 8ca3bb7680b4..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json +++ /dev/null @@ -1,232 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model2" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "projectKind": "CustomEntityRecognition", - "customEntityRecognitionEvaluation": { - "confusionMatrix": { - "BorrowerAddress": { - "BorrowerAddress": { - "normalizedValue": 86.206894, - "rawValue": 3.4482758 - }, - "$none": { - "normalizedValue": 13.793103, - "rawValue": 0.55172414 - } - }, - "BorrowerCity": { - "BorrowerCity": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "BorrowerName": { - "BorrowerName": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "BorrowerState": { - "BorrowerState": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "Date": { - "Date": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "Interest": { - "Interest": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LenderAddress": { - "LenderAddress": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LenderCity": { - "LenderCity": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LenderName": { - "LenderName": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LenderState": { - "LenderState": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LoanAmountNumbers": { - "LoanAmountNumbers": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LoanAmountWords": { - "LoanAmountWords": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "$none": { - "$none": { - "normalizedValue": 99.81485, - "rawValue": 51.90372 - }, - "BorrowerAddress": { - "normalizedValue": 0.18315019, - "rawValue": 0.0952381 - }, - "Interest": { - "normalizedValue": 0.002005294, - "rawValue": 0.0010427529 - } - } - }, - "entities": { - "Date": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "BorrowerName": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "BorrowerAddress": { - "f1": 0.6666666865348816, - "precision": 0.6000000238418579, - "recall": 0.75, - "truePositiveCount": 3, - "trueNegativeCount": 0, - "falsePositiveCount": 2, - "falseNegativeCount": 1 - }, - "BorrowerCity": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "BorrowerState": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LenderName": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LenderAddress": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LenderCity": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LenderState": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LoanAmountWords": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LoanAmountNumbers": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Interest": { - "f1": 0.75, - "precision": 0.75, - "recall": 0.75, - "truePositiveCount": 3, - "trueNegativeCount": 0, - "falsePositiveCount": 1, - "falseNegativeCount": 1 - } - }, - "microF1": 0.94845366, - "microPrecision": 0.93877554, - "microRecall": 0.9583333, - "macroF1": 0.9513889, - "macroPrecision": 0.9458334, - "macroRecall": 0.9583333 - }, - "evaluationOptions": { - "kind": "percentage", - "trainingSplitPercentage": 80, - "testingSplitPercentage": 20 - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetProject.json deleted file mode 100644 index 7f9902d22243..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetProject.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json deleted file mode 100644 index aab8c6504e79..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000", - "createdDateTime": "2022-04-18T14:02:34Z", - "lastUpdatedDateTime": "2022-04-18T14:02:34Z", - "expirationDateTime": "2022-04-25T14:02:34Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json deleted file mode 100644 index 3bafacb1d1a6..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json +++ /dev/null @@ -1,389 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "languageName": "English", - "languageCode": "en" - }, - { - "languageName": "English", - "languageCode": "en-us" - }, - { - "languageName": "French", - "languageCode": "fr" - }, - { - "languageName": "Italian", - "languageCode": "it" - }, - { - "languageName": "Spanish", - "languageCode": "es" - }, - { - "languageName": "German", - "languageCode": "de" - }, - { - "languageName": "Portuguese (Brazil)", - "languageCode": "pt-br" - }, - { - "languageName": "Portuguese (Portugal)", - "languageCode": "pt-pt" - }, - { - "languageName": "Afrikaans", - "languageCode": "af" - }, - { - "languageName": "Amharic", - "languageCode": "am" - }, - { - "languageName": "Arabic", - "languageCode": "ar" - }, - { - "languageName": "Assamese", - "languageCode": "as" - }, - { - "languageName": "Azerbaijani", - "languageCode": "az" - }, - { - "languageName": "Belarusian", - "languageCode": "be" - }, - { - "languageName": "Bulgarian", - "languageCode": "bg" - }, - { - "languageName": "Breton", - "languageCode": "br" - }, - { - "languageName": "Bosnian", - "languageCode": "bs" - }, - { - "languageName": "Catalan", - "languageCode": "ca" - }, - { - "languageName": "Czech", - "languageCode": "cs" - }, - { - "languageName": "Welsh", - "languageCode": "cy" - }, - { - "languageName": "Danish", - "languageCode": "da" - }, - { - "languageName": "Greek", - "languageCode": "el" - }, - { - "languageName": "Esperanto", - "languageCode": "eo" - }, - { - "languageName": "Estonian", - "languageCode": "et" - }, - { - "languageName": "Basque", - "languageCode": "eu" - }, - { - "languageName": "Persian", - "languageCode": "fa" - }, - { - "languageName": "Finnish", - "languageCode": "fi" - }, - { - "languageName": "Western Frisian", - "languageCode": "fy" - }, - { - "languageName": "Irish", - "languageCode": "ga" - }, - { - "languageName": "Scottish Gaelic", - "languageCode": "gd" - }, - { - "languageName": "Galician", - "languageCode": "gl" - }, - { - "languageName": "Gujarati", - "languageCode": "gu" - }, - { - "languageName": "Hausa", - "languageCode": "ha" - }, - { - "languageName": "Hebrew", - "languageCode": "he" - }, - { - "languageName": "Hindi", - "languageCode": "hi" - }, - { - "languageName": "Croatian", - "languageCode": "hr" - }, - { - "languageName": "Hungarian", - "languageCode": "hu" - }, - { - "languageName": "Armenian", - "languageCode": "hy" - }, - { - "languageName": "Indonesian", - "languageCode": "id" - }, - { - "languageName": "Japanese", - "languageCode": "ja" - }, - { - "languageName": "Javanese", - "languageCode": "jv" - }, - { - "languageName": "Georgian", - "languageCode": "ka" - }, - { - "languageName": "Kazakh", - "languageCode": "kk" - }, - { - "languageName": "Khmer", - "languageCode": "km" - }, - { - "languageName": "Kannada", - "languageCode": "kn" - }, - { - "languageName": "Korean", - "languageCode": "ko" - }, - { - "languageName": "Kurdish (Kurmanji)", - "languageCode": "ku" - }, - { - "languageName": "Kyrgyz", - "languageCode": "ky" - }, - { - "languageName": "Latin", - "languageCode": "la" - }, - { - "languageName": "Lao", - "languageCode": "lo" - }, - { - "languageName": "Lithuanian", - "languageCode": "lt" - }, - { - "languageName": "Latvian", - "languageCode": "lv" - }, - { - "languageName": "Malagasy", - "languageCode": "mg" - }, - { - "languageName": "Macedonian", - "languageCode": "mk" - }, - { - "languageName": "Malayalam", - "languageCode": "ml" - }, - { - "languageName": "Mongolian", - "languageCode": "mn" - }, - { - "languageName": "Marathi", - "languageCode": "mr" - }, - { - "languageName": "Malay", - "languageCode": "ms" - }, - { - "languageName": "Burmese", - "languageCode": "my" - }, - { - "languageName": "Nepali", - "languageCode": "ne" - }, - { - "languageName": "Dutch", - "languageCode": "nl" - }, - { - "languageName": "Norwegian (Bokmal)", - "languageCode": "nb" - }, - { - "languageName": "Odia", - "languageCode": "or" - }, - { - "languageName": "Punjabi", - "languageCode": "pa" - }, - { - "languageName": "Polish", - "languageCode": "pl" - }, - { - "languageName": "Pashto", - "languageCode": "ps" - }, - { - "languageName": "Romanian", - "languageCode": "ro" - }, - { - "languageName": "Russian", - "languageCode": "ru" - }, - { - "languageName": "Sanskrit", - "languageCode": "sa" - }, - { - "languageName": "Sindhi", - "languageCode": "sd" - }, - { - "languageName": "Sinhala", - "languageCode": "si" - }, - { - "languageName": "Slovak", - "languageCode": "sk" - }, - { - "languageName": "Slovenian", - "languageCode": "sl" - }, - { - "languageName": "Somali", - "languageCode": "so" - }, - { - "languageName": "Albanian", - "languageCode": "sq" - }, - { - "languageName": "Serbian", - "languageCode": "sr" - }, - { - "languageName": "Sundanese", - "languageCode": "su" - }, - { - "languageName": "Swedish", - "languageCode": "sv" - }, - { - "languageName": "Swahili", - "languageCode": "sw" - }, - { - "languageName": "Tamil", - "languageCode": "ta" - }, - { - "languageName": "Telugu", - "languageCode": "te" - }, - { - "languageName": "Thai", - "languageCode": "th" - }, - { - "languageName": "Filipino", - "languageCode": "tl" - }, - { - "languageName": "Turkish", - "languageCode": "tr" - }, - { - "languageName": "Uyghur", - "languageCode": "ug" - }, - { - "languageName": "Ukrainian", - "languageCode": "uk" - }, - { - "languageName": "Urdu", - "languageCode": "ur" - }, - { - "languageName": "Uzbek", - "languageCode": "uz" - }, - { - "languageName": "Vietnamese", - "languageCode": "vi" - }, - { - "languageName": "Xhosa", - "languageCode": "xh" - }, - { - "languageName": "Yiddish", - "languageCode": "yi" - }, - { - "languageName": "Chinese (Simplified)", - "languageCode": "zh-hans" - }, - { - "languageName": "Chinese (Traditional)", - "languageCode": "zh-hant" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json deleted file mode 100644 index 1cfa69ad9e53..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectKind": "CustomEntityRecognition" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "trainingConfigVersion": "2022-05-01", - "modelExpirationDate": "2022-10-28" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json deleted file mode 100644 index 5d26fcda99d0..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", - "createdDateTime": "2022-04-18T16:09:50Z", - "lastUpdatedDateTime": "2022-04-18T16:09:58Z", - "expirationDateTime": "2022-04-25T16:09:50Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json deleted file mode 100644 index 4b3ab619d842..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "result": { - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", - "trainingStatus": { - "percentComplete": 3, - "startDateTime": "2022-04-18T15:45:06.8190649Z", - "status": "running" - }, - "evaluationStatus": { - "percentComplete": 0, - "status": "notStarted" - } - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:45:48Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "running" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulImportProject.json deleted file mode 100644 index dee0e23bd93c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulImportProject.json +++ /dev/null @@ -1,99 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "body": { - "projectFileVersion": "2022-05-01", - "stringIndexType": "Utf16CodeUnit", - "metadata": { - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "settings": {}, - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - }, - "assets": { - "projectKind": "CustomEntityRecognition", - "entities": [ - { - "category": "Date" - }, - { - "category": "LenderName" - }, - { - "category": "LenderAddress" - } - ], - "documents": [ - { - "location": "01.txt", - "language": "en-us", - "entities": [ - { - "regionOffset": 0, - "regionLength": 1793, - "labels": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "LenderName", - "offset": 273, - "length": 14 - }, - { - "category": "LenderAddress", - "offset": 314, - "length": 15 - } - ] - } - ] - }, - { - "location": "02.txt", - "language": "en-us", - "entities": [ - { - "regionOffset": 0, - "regionLength": 1804, - "labels": [ - { - "category": "Date", - "offset": 5, - "length": 10 - }, - { - "category": "LenderName", - "offset": 284, - "length": 10 - }, - { - "category": "LenderAddress", - "offset": 321, - "length": 20 - } - ] - } - ] - } - ] - } - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulListDeployments.json deleted file mode 100644 index d61ce69659d4..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulListDeployments.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "deploymentName": "production", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T16:03:51Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01" - }, - { - "deploymentName": "staging", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T15:53:04Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulListModels.json deleted file mode 100644 index bf9a51084b1f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulListModels.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-01", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "label": "model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49Z", - "lastTrainingDurationInSeconds": 186, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01" - }, - { - "label": "model2", - "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", - "lastTrainedDateTime": "2022-04-18T17:25:22Z", - "lastTrainingDurationInSeconds": 192, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulListProjects.json deleted file mode 100644 index c11174dbb9b4..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulListProjects.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - }, - { - "createdDateTime": "2022-04-18T14:03:12Z", - "lastModifiedDateTime": "2022-04-18T14:03:12Z", - "projectKind": "CustomMultiLabelClassification", - "storageInputContainerName": "loanagreements", - "projectName": "MoviesSummary", - "multilingual": false, - "description": "This is a sample dataset adapted from the CMU Movie Summary public dataset. This was prepared by Microsoft Azure Language Services product team to prepare this dataset to be used as a sample for getting started with Custom text classification. This sample dataset consists of 210 files each of them is a movie summary. Each movie can be classified into one or more of the following classes: \"Mystery\", \"Drama\", \"Thriller\", \"Comedy\", \"Action\".", - "language": "en" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json deleted file mode 100644 index 354a70e07960..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json +++ /dev/null @@ -1,87 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "result": { - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T15:45:06.8190649Z", - "endDateTime": "2022-04-18T15:47:19.2639682Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T15:47:19.2734976Z", - "endDateTime": "2022-04-18T15:47:23.8378892Z", - "status": "succeeded" - } - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:47:50Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "succeeded" - }, - { - "result": { - "modelLabel": "model2", - "trainingConfigVersion": "2022-05-01", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:22:39.3663023Z", - "endDateTime": "2022-04-18T17:24:51.9440947Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:24:51.9571747Z", - "endDateTime": "2022-04-18T17:24:58.1427823Z", - "status": "succeeded" - } - }, - "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", - "createdDateTime": "2022-04-18T17:22:11Z", - "lastUpdatedDateTime": "2022-04-18T17:25:23Z", - "expirationDateTime": "2022-04-25T17:22:11Z", - "status": "succeeded" - }, - { - "result": { - "modelLabel": "model2", - "trainingConfigVersion": "2022-05-01", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:44:41.388358Z", - "endDateTime": "2022-04-18T17:50:29.5675101Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:50:29.5808461Z", - "endDateTime": "2022-04-18T17:50:35.3482185Z", - "status": "succeeded" - } - }, - "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", - "createdDateTime": "2022-04-18T17:44:04Z", - "lastUpdatedDateTime": "2022-04-18T17:51:11Z", - "expirationDateTime": "2022-04-25T17:44:04Z", - "status": "succeeded" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulSwapDeployments.json deleted file mode 100644 index bfa02d6f330a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulSwapDeployments.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "body": { - "firstDeploymentName": "production", - "secondDeploymentName": "staging" - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2022-05-01" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulTrainProject.json deleted file mode 100644 index 7e67ced9894c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/analyzetext-authoring/SuccessfulTrainProject.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements", - "body": { - "modelLabel": "model1", - "trainingConfigVersion": "latest", - "evaluationOptions": { - "kind": "percentage", - "testingSplitPercentage": 20, - "trainingSplitPercentage": 80 - } - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulAnalyzeConversations.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulAnalyzeConversations.json deleted file mode 100644 index 7faf19857a9c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulAnalyzeConversations.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-05-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "id": "1", - "participantId": "1", - "text": "play In the air tonight from Phil Collins" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "play In the air tonight from Phil Collins", - "prediction": { - "topIntent": "PlayMusic", - "projectKind": "Conversation", - "intents": [ - { - "category": "PlayMusic", - "confidenceScore": 1 - }, - { - "category": "SearchCreativeWork", - "confidenceScore": 0 - }, - { - "category": "AddToPlaylist", - "confidenceScore": 0 - } - ], - "entities": [ - { - "category": "Media.Artist", - "text": "Phil Collins", - "offset": 29, - "length": 12, - "confidenceScore": 1 - } - ] - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json deleted file mode 100644 index d1a226fe73a5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-05-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "participantId": "1", - "id": "1", - "modality": "text", - "language": "en-GB", - "text": "How do I integrate QnA Maker and LUIS?" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "verbose": true, - "isLoggingEnabled": false, - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Rail", - "projectKind": "Orchestration", - "intents": { - "Rail": { - "confidenceScore": 1, - "targetProjectKind": "Conversation", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Timetable", - "projectKind": "Conversation", - "intents": [ - { - "category": "Timetable", - "confidenceScore": 0.99968535 - }, - { - "category": "Locomotive", - "confidenceScore": 0.000314623 - } - ], - "entities": [] - } - } - }, - "Tree": { - "confidenceScore": 0.2641529, - "targetProjectKind": "QuestionAnswering" - }, - "None": { - "confidenceScore": 0, - "targetProjectKind": "NonLinked" - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json deleted file mode 100644 index 335105038ef6..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-05-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "text": "Ports and connectors", - "participantId": "1", - "id": "1" - } - }, - "parameters": { - "projectName": "prj1", - "deploymentName": "dep1", - "directTarget": "qnaProject", - "targetProjectParameters": { - "qnaProject": { - "targetProjectKind": "QuestionAnswering", - "callingOptions": { - "context": { - "previousUserQuery": "Meet Surface Pro 4", - "previousQnaId": 4 - }, - "top": 1, - "question": "App Service overview" - } - } - } - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "Ports and connectors", - "prediction": { - "projectKind": "Orchestration", - "topIntent": "qnaTargetApp", - "intents": { - "qnaTargetApp": { - "targetProjectKind": "QuestionAnswering", - "confidenceScore": 1, - "result": { - "answers": [ - { - "questions": [ - "App Service overview" - ], - "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.", - "confidenceScore": 0.7384000000000001, - "id": 1, - "source": "https://docs.microsoft.com/en-us/azure/app-service/overview", - "metadata": {}, - "dialog": { - "isContextOnly": false, - "prompts": [] - } - } - ] - } - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json deleted file mode 100644 index c5263bc5e960..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversations/jobs/{jobId}?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulConversationPIISubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulConversationPIISubmit.json deleted file mode 100644 index f4db5ac55df7..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulConversationPIISubmit.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "audioTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "piiCategories": [ - "All" - ], - "redactionSource": "lexical", - "includeAudioRedaction": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulConversationPIITaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulConversationPIITaskStatusRequest.json deleted file mode 100644 index 86ce4b5820b4..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulConversationPIITaskStatusRequest.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "ConversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning *************.", - "itn": "good morning *************", - "maskedItn": "good morning *************", - "lexical": "good morning *************", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [ - { - "category": "Name", - "confidenceScore": 0.91, - "length": 8, - "offset": 13, - "text": "john doe" - } - ] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json deleted file mode 100644 index b260b11a4b2c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Analyze chat", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "ConversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "analyze 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "20220101meeting", - "summaries": [ - { - "aspect": "issue", - "text": "Customer wants to cancel his subscription. Customer doesn't know how" - }, - { - "aspect": "resolution", - "text": "pii Auto-Fortify. \npii Gamertag.\npii E-mail.\nCanceled customer's subscription" - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2020-05-15-preview" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulConversationSummarySubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulConversationSummarySubmit.json deleted file mode 100644 index 7e05639c79dc..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-05-15-preview/examples/conversations/SuccessfulConversationSummarySubmit.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Analyze conversations from Contoso meeting", - "analysisInput": { - "conversations": [ - { - "id": "20220101meeting", - "language": "en", - "modality": "text", - "domain": "generic", - "conversationItems": [ - { - "participantId": "user", - "role": "customer", - "id": "1", - "text": "Hi!" - }, - { - "participantId": "agent", - "role": "agent", - "id": "2", - "text": "Hello, how can I help you?" - }, - { - "participantId": "user", - "role": "customer", - "id": "3", - "text": "I am having trouble issuing a return of a game on my xbox: call of duty" - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "analyze 1", - "kind": "ConversationalSummarizationTask", - "parameters": { - "modelVersion": "latest", - "summaryAspects": [ - "issue", - "resolution" - ] - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/analyzeconversations-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/analyzeconversations-authoring.json deleted file mode 100644 index 56c0c55d36d4..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/analyzeconversations-authoring.json +++ /dev/null @@ -1,3102 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Analyze Conversations Authoring", - "version": "2022-07-01-preview", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview." - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/authoring/analyze-conversations/projects": { - "get": { - "description": "Lists the existing projects.", - "operationId": "ConversationalAnalysisAuthoring_ListProjects", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of projects.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectsMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Projects": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListProjects.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}": { - "patch": { - "description": "Creates a new project or updates an existing one.", - "operationId": "ConversationalAnalysisAuthoring_CreateProject", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The project parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of the updated project, if it already exists.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "201": { - "description": "The metadata of the created project.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Create Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateProject.json" - } - } - }, - "get": { - "description": "Gets the details of a project.", - "operationId": "ConversationalAnalysisAuthoring_GetProject", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of the project.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProject.json" - } - } - }, - "delete": { - "description": "Deletes a project.", - "operationId": "ConversationalAnalysisAuthoring_DeleteProject", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/:export": { - "post": { - "description": "Triggers a job to export a project's data.", - "operationId": "ConversationalAnalysisAuthoring_Export", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" - }, - { - "in": "query", - "name": "assetKind", - "description": "Kind of asset to export.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Export Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulExportProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/:import": { - "post": { - "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", - "operationId": "ConversationalAnalysisAuthoring_Import", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryParameter" - }, - { - "in": "body", - "name": "body", - "description": "The project data to import.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProject" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Import Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulImportProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/:train": { - "post": { - "description": "Triggers a training job for a project.", - "operationId": "ConversationalAnalysisAuthoring_Train", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The training input parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Train Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulTrainProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments": { - "get": { - "description": "Lists the deployments belonging to a project.", - "operationId": "ConversationalAnalysisAuthoring_ListDeployments", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all deployments.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployments" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeployments.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { - "post": { - "description": "Swaps two existing deployments with each other.", - "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The job object to swap two deployments.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Swap Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": { - "get": { - "description": "Gets the details of a deployment.", - "operationId": "ConversationalAnalysisAuthoring_GetDeployment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The Deployment info.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeployment.json" - } - } - }, - "put": { - "description": "Creates a new deployment or replaces an existing one.", - "operationId": "ConversationalAnalysisAuthoring_DeployProject", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The new deployment info.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateDeploymentOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Deploy Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeployProject.json" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "description": "Deletes a project deployment.", - "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing deployment job.", - "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The deployment job result.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Deployment Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing swap deployment job.", - "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The swap deployment job result.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Swap Deployments Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": { - "get": { - "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", - "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The status of the long running operation.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportProjectJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Export Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { - "get": { - "description": "Gets the status for an import.", - "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The details of the long running operation.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringImportProjectJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Import Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models": { - "get": { - "description": "Lists the trained models belonging to a project.", - "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all trained models.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModels" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Models": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListModels.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": { - "get": { - "description": "Gets the details of a trained model.", - "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Trained model info", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModel.json" - } - } - }, - "delete": { - "description": "Deletes an existing trained model.", - "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "204": { - "description": "Deleted successfully." - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteModel.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { - "get": { - "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", - "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of the evaluation predictions.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationResults" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model Evaluation": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { - "get": { - "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", - "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all evaluation results.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationSummary" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model Evaluation Summary": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/train/jobs": { - "get": { - "description": "Lists the non-expired training jobs created for a project.", - "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of the training jobs.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobs" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Training Jobs": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": { - "get": { - "description": "Gets the status for a training job.", - "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The training job result.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Train Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": { - "post": { - "description": "Triggers a cancellation for a running training job.", - "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the job cancellation.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Cancel Training Job": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": { - "get": { - "description": "Gets the status for a project deletion job.", - "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The project deletion job result.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeletionJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Project Deletion Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/global/languages": { - "get": { - "description": "Lists the supported languages for the given project type.", - "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of supported languages.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguages" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Supported Languages": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/global/prebuilt-entities": { - "get": { - "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", - "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "language", - "description": "The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "in": "query", - "name": "multilingual", - "description": "Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of supported prebuilt entities.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntities" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Supported Prebuilt Entities": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/global/training-config-versions": { - "get": { - "description": "Lists the support training config version for a given project type.", - "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of config versions.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersions" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Supported Training Config Versions": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - } - }, - "definitions": { - "ConversationalAnalysisAuthoringCompositionSetting": { - "enum": [ - "returnLongestOverlap", - "requireExactOverlap", - "separateComponents", - "combineComponents" - ], - "type": "string", - "x-ms-enum": { - "name": "CompositionSetting", - "modelAsString": true, - "values": [ - { - "value": "returnLongestOverlap", - "description": "When two or more components are found in the text and overlap, the component with the longest set of characters is returned." - }, - { - "value": "requireExactOverlap", - "description": "All components must overlap at the exact same characters in the text for the entity to return. If one of the defined components is not matched or predicted, the entity will not return." - }, - { - "value": "separateComponents", - "description": "Every component's match or prediction is returned as a separate instance of the entity." - }, - { - "value": "combineComponents", - "description": "When two or more components are found in the text and overlap, the components' spans are merged together into one span combining all of them." - } - ] - }, - "x-ms-client-name": "CompositionSetting" - }, - "ConversationalAnalysisAuthoringConfusionMatrix": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixRow" - }, - "x-ms-client-name": "ConfusionMatrix" - }, - "ConversationalAnalysisAuthoringConfusionMatrixCell": { - "description": "Represents a cell in a confusion matrix.", - "required": [ - "normalizedValue", - "rawValue" - ], - "type": "object", - "properties": { - "normalizedValue": { - "format": "float", - "description": "Represents normalized value in percentages.", - "type": "number" - }, - "rawValue": { - "format": "float", - "description": "Represents raw value.", - "type": "number" - } - }, - "x-ms-client-name": "ConfusionMatrixCell" - }, - "ConversationalAnalysisAuthoringConfusionMatrixRow": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixCell" - }, - "x-ms-client-name": "ConfusionMatrixRow" - }, - "ConversationalAnalysisAuthoringConversationExportedEntity": { - "description": "Represents an entity with its components.", - "required": [ - "category" - ], - "type": "object", - "properties": { - "category": { - "description": "The category of the entity.", - "type": "string" - }, - "compositionSetting": { - "description": "The behavior to follow when the entity's components overlap with each other.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringCompositionSetting" - }, - "list": { - "description": "The list component of the entity.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityList" - }, - "prebuilts": { - "description": "The prebuilt entities components.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedPrebuiltEntity" - } - } - }, - "x-ms-client-name": "ConversationExportedEntity" - }, - "ConversationalAnalysisAuthoringConversationExportedIntent": { - "description": "Represents an exported intent of a conversational project.", - "required": [ - "category" - ], - "type": "object", - "properties": { - "category": { - "description": "The intent category.", - "type": "string" - } - }, - "x-ms-client-name": "ConversationExportedIntent" - }, - "ConversationalAnalysisAuthoringConversationExportedProjectAssets": { - "description": "Represents the exported assets of a conversational project.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" - } - ], - "properties": { - "intents": { - "description": "The intents defined in the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedIntent" - } - }, - "entities": { - "description": "The entities defined in the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedEntity" - } - }, - "utterances": { - "description": "The utterances defined in the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedUtterance" - } - } - }, - "x-ms-discriminator-value": "Conversation", - "x-ms-client-name": "ConversationExportedProjectAssets" - }, - "ConversationalAnalysisAuthoringConversationExportedUtterance": { - "description": "Represents an exported utterance for a conversational project.", - "required": [ - "text", - "intent" - ], - "type": "object", - "properties": { - "entities": { - "description": "Represents the entity labels of the utterance.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedUtteranceEntityLabel" - } - }, - "text": { - "description": "The utterance text.", - "type": "string" - }, - "language": { - "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "intent": { - "description": "The intent of the utterance.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "ConversationExportedUtterance" - }, - "ConversationalAnalysisAuthoringCreateDeploymentOptions": { - "description": "Represents the options for creating or updating a project deployment.", - "required": [ - "trainedModelLabel" - ], - "type": "object", - "properties": { - "trainedModelLabel": { - "description": "Represents the trained model label.", - "type": "string" - } - }, - "x-ms-client-name": "CreateDeploymentOptions" - }, - "ConversationalAnalysisAuthoringCreateProjectOptions": { - "description": "Represents the options used to create or update a project.", - "required": [ - "projectKind", - "projectName", - "language" - ], - "type": "object", - "properties": { - "projectKind": { - "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" - }, - "settings": { - "description": "The project settings.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" - }, - "projectName": { - "description": "The new project name.", - "type": "string" - }, - "multilingual": { - "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" - }, - "description": { - "description": "The project description.", - "type": "string" - }, - "language": { - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "CreateProjectOptions" - }, - "ConversationalAnalysisAuthoringDeploymentJobState": { - "description": "Represents the state of a deployment job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "DeploymentJobState" - }, - "ConversationalAnalysisAuthoringEntitiesEvaluationSummary": { - "description": "Represents the evaluation result summary for the project's entities.", - "required": [ - "confusionMatrix", - "entities", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], - "type": "object", - "properties": { - "confusionMatrix": { - "description": "Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" - }, - "entities": { - "description": "Represents the entities evaluation summary.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringEntityEvaluationSummary" - } - }, - "microF1": { - "format": "float", - "description": "Represents the micro F1", - "type": "number" - }, - "microPrecision": { - "format": "float", - "description": "Represents the micro precision", - "type": "number" - }, - "microRecall": { - "format": "float", - "description": "Represents the micro recall", - "type": "number" - }, - "macroF1": { - "format": "float", - "description": "Represents the macro F1", - "type": "number" - }, - "macroPrecision": { - "format": "float", - "description": "Represents the macro precision", - "type": "number" - }, - "macroRecall": { - "format": "float", - "description": "Represents the macro recall", - "type": "number" - } - }, - "x-ms-client-name": "EntitiesEvaluationSummary" - }, - "ConversationalAnalysisAuthoringEntityEvaluationSummary": { - "description": "Represents the evaluation result for an entity.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], - "type": "object", - "properties": { - "f1": { - "format": "double", - "description": "Represents the model precision", - "type": "number" - }, - "precision": { - "format": "double", - "description": "Represents the model recall", - "type": "number" - }, - "recall": { - "format": "double", - "description": "Represents the model F1 score", - "type": "number" - }, - "truePositiveCount": { - "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" - }, - "trueNegativeCount": { - "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" - }, - "falsePositiveCount": { - "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" - }, - "falseNegativeCount": { - "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" - } - }, - "x-ms-client-name": "EntityEvaluationSummary" - }, - "ConversationalAnalysisAuthoringEvaluationKind": { - "enum": [ - "percentage", - "manual" - ], - "type": "string", - "x-ms-enum": { - "name": "EvaluationKind", - "modelAsString": true, - "values": [ - { - "value": "percentage", - "description": "Split the data into training and test sets according to user-defined percentages." - }, - { - "value": "manual", - "description": "Split the data according to the chosen dataset for every example in the data." - } - ] - }, - "x-ms-client-name": "EvaluationKind" - }, - "ConversationalAnalysisAuthoringEvaluationOptions": { - "description": "Represents the options used running the evaluation.", - "type": "object", - "properties": { - "kind": { - "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationKind" - }, - "trainingSplitPercentage": { - "format": "int32", - "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" - }, - "testingSplitPercentage": { - "format": "int32", - "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" - } - }, - "x-ms-client-name": "EvaluationOptions" - }, - "ConversationalAnalysisAuthoringEvaluationResults": { - "description": "Represent a list of utterances' evaluation results.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The utterances evaluation results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEvaluationResult" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "EvaluationResults" - }, - "ConversationalAnalysisAuthoringEvaluationSummary": { - "description": "Represents the evaluation result summary.", - "required": [ - "entitiesEvaluation", - "intentsEvaluation" - ], - "type": "object", - "properties": { - "entitiesEvaluation": { - "description": "Contains the data related to entities evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEntitiesEvaluationSummary" - }, - "intentsEvaluation": { - "description": "Contains the data related to intents evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentsEvaluationSummary" - }, - "evaluationOptions": { - "description": "The options that were used while running the evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" - } - }, - "x-ms-client-name": "EvaluationSummary" - }, - "ConversationalAnalysisAuthoringExportedConversationOrchestration": { - "description": "Defines the orchestration details for a Conversational project target.", - "required": [ - "projectName", - "deploymentName" - ], - "type": "object", - "properties": { - "projectName": { - "description": "The name of the targeted project.", - "type": "string" - }, - "deploymentName": { - "description": "The name of the targeted deployment.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedConversationOrchestration" - }, - "ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions": { - "description": "Represents the orchestration options for a Conversational project target.", - "required": [ - "conversationOrchestration" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" - } - ], - "properties": { - "conversationOrchestration": { - "description": "The Conversational project target details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedConversationOrchestration" - } - }, - "x-ms-discriminator-value": "Conversation", - "x-ms-client-name": "ExportedConversationOrchestrationOptions" - }, - "ConversationalAnalysisAuthoringExportedEntityList": { - "description": "Represents a list component of an entity.", - "type": "object", - "properties": { - "sublists": { - "description": "The sub-lists of the list component.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntitySublist" - } - } - }, - "x-ms-client-name": "ExportedEntityList" - }, - "ConversationalAnalysisAuthoringExportedEntityListSynonym": { - "description": "Represents a list of synonyms inside a list component", - "type": "object", - "properties": { - "language": { - "description": "Represents the language of the synonyms. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "values": { - "description": "The list of synonyms.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ms-client-name": "ExportedEntityListSynonym" - }, - "ConversationalAnalysisAuthoringExportedEntitySublist": { - "description": "Represents a sub-list inside a list component.", - "type": "object", - "properties": { - "listKey": { - "description": "The key of the sub-list.", - "type": "string" - }, - "synonyms": { - "description": "The phrases of that correspond to the sub-list.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityListSynonym" - } - } - }, - "x-ms-client-name": "ExportedEntitySublist" - }, - "ConversationalAnalysisAuthoringExportedLuisOrchestration": { - "description": "Defines the orchestration details for a LUIS application target.", - "required": [ - "appId" - ], - "type": "object", - "properties": { - "appId": { - "format": "uuid", - "description": "The LUIS application ID.", - "type": "string", - "example": "00000000-0000-0000-0000-000000000000" - }, - "appVersion": { - "description": "The targeted version Id.", - "type": "string" - }, - "slotName": { - "description": "The targeted slot name.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedLuisOrchestration" - }, - "ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions": { - "description": "Represents the orchestration options for a LUIS application target.", - "required": [ - "luisOrchestration" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" - } - ], - "properties": { - "luisOrchestration": { - "description": "The LUIS application target details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedLuisOrchestration" - } - }, - "x-ms-discriminator-value": "Luis", - "x-ms-client-name": "ExportedLuisOrchestrationOptions" - }, - "ConversationalAnalysisAuthoringExportedOrchestrationOptions": { - "description": "Represents the options used to define the orchestration behavior of an intent.", - "required": [ - "targetProjectKind" - ], - "type": "object", - "properties": { - "targetProjectKind": { - "description": "The kind of the target used in the orchestration flow.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationTargetProjectKind" - } - }, - "discriminator": "targetProjectKind", - "x-ms-client-name": "ExportedOrchestrationOptions" - }, - "ConversationalAnalysisAuthoringExportedPrebuiltEntity": { - "description": "Represents an exported prebuilt entity component", - "required": [ - "category" - ], - "type": "object", - "properties": { - "category": { - "description": "The prebuilt entity category.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedPrebuiltEntity" - }, - "ConversationalAnalysisAuthoringExportedProject": { - "description": "Represents an exported project.", - "required": [ - "projectFileVersion", - "stringIndexType", - "metadata" - ], - "type": "object", - "properties": { - "projectFileVersion": { - "description": "The version of the exported file.", - "type": "string" - }, - "stringIndexType": { - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringStringIndexType" - }, - "metadata": { - "description": "Represents the project metadata.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" - }, - "assets": { - "description": "Represents the project assets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" - } - }, - "x-ms-client-name": "ExportedProject" - }, - "ConversationalAnalysisAuthoringExportedProjectAssets": { - "description": "Represents the assets of an exported project.", - "required": [ - "projectKind" - ], - "type": "object", - "properties": { - "projectKind": { - "description": "The type of project containing the assets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" - } - }, - "discriminator": "projectKind", - "x-ms-client-name": "ExportedProjectAssets" - }, - "ConversationalAnalysisAuthoringExportedProjectFormat": { - "enum": [ - "Conversation", - "Luis" - ], - "type": "string", - "x-ms-enum": { - "name": "ExportedProjectFormat", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "Specifies the format for a conversational project." - }, - { - "value": "Luis", - "description": "Specifies the format for an application that was exported from LUIS." - } - ] - }, - "x-ms-client-name": "ExportedProjectFormat" - }, - "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration": { - "description": "Defines the orchestration details for a Question Answering project target.", - "required": [ - "projectName" - ], - "type": "object", - "properties": { - "projectName": { - "description": "The name of the target project.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedQuestionAnsweringOrchestration" - }, - "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions": { - "description": "Represents the orchestration options for a Question Answering project target.", - "required": [ - "questionAnsweringOrchestration" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" - } - ], - "properties": { - "questionAnsweringOrchestration": { - "description": "The Question Answering project details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration" - } - }, - "x-ms-discriminator-value": "QuestionAnswering", - "x-ms-client-name": "ExportedQuestionAnsweringOrchestrationOptions" - }, - "ConversationalAnalysisAuthoringExportedUtteranceEntityLabel": { - "description": "Represents an entity label for an utterance.", - "required": [ - "category", - "offset", - "length" - ], - "type": "object", - "properties": { - "category": { - "description": "The category of the entity label.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "Start position for the entity text.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "Length for the entity text.", - "type": "integer" - } - }, - "x-ms-client-name": "ExportedUtteranceEntityLabel" - }, - "ConversationalAnalysisAuthoringExportProjectJobState": { - "description": "Represents the state of an export job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "properties": { - "resultUrl": { - "description": "The URL to use in order to download the exported project.", - "type": "string" - } - }, - "x-ms-client-name": "ExportProjectJobState" - }, - "ConversationalAnalysisAuthoringImportProjectJobState": { - "description": "Represents the state of an import job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "ImportProjectJobState" - }, - "ConversationalAnalysisAuthoringIntentEvaluationSummary": { - "description": "The evaluation summary for an intent.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], - "type": "object", - "properties": { - "f1": { - "format": "double", - "description": "Represents the model precision", - "type": "number" - }, - "precision": { - "format": "double", - "description": "Represents the model recall", - "type": "number" - }, - "recall": { - "format": "double", - "description": "Represents the model F1 score", - "type": "number" - }, - "truePositiveCount": { - "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" - }, - "trueNegativeCount": { - "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" - }, - "falsePositiveCount": { - "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" - }, - "falseNegativeCount": { - "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" - } - }, - "x-ms-client-name": "IntentEvaluationSummary" - }, - "ConversationalAnalysisAuthoringIntentsEvaluationSummary": { - "description": "Represents the evaluation summary for the project's intents.", - "required": [ - "confusionMatrix", - "intents", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], - "type": "object", - "properties": { - "confusionMatrix": { - "description": "Represents the confusion matrix between two intents (the two intents can be the same). The matrix is between the intent that was labelled and the intent that was predicted.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" - }, - "intents": { - "description": "Represents the intents evaluation summary.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentEvaluationSummary" - } - }, - "microF1": { - "format": "float", - "description": "Represents the micro F1", - "type": "number" - }, - "microPrecision": { - "format": "float", - "description": "Represents the micro precision", - "type": "number" - }, - "microRecall": { - "format": "float", - "description": "Represents the micro recall", - "type": "number" - }, - "macroF1": { - "format": "float", - "description": "Represents the macro F1", - "type": "number" - }, - "macroPrecision": { - "format": "float", - "description": "Represents the macro precision", - "type": "number" - }, - "macroRecall": { - "format": "float", - "description": "Represents the macro recall", - "type": "number" - } - }, - "x-ms-client-name": "IntentsEvaluationSummary" - }, - "ConversationalAnalysisAuthoringJobState": { - "description": "Represents a job's state.", - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ], - "type": "object", - "properties": { - "jobId": { - "description": "The job ID.", - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "description": "The creation date time of the job.", - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "description": "The last date time the job was updated.", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "description": "The expiration date time of the job.", - "type": "string" - }, - "status": { - "description": "The job status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" - }, - "warnings": { - "description": "The warnings that were encountered while executing the job.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringWarning" - } - }, - "errors": { - "description": "The errors encountered while executing the job.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - } - }, - "x-ms-client-name": "JobState" - }, - "ConversationalAnalysisAuthoringJobStatus": { - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling", - "partiallyCompleted" - ], - "type": "string", - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true - }, - "x-ms-client-name": "JobStatus" - }, - "ConversationalAnalysisAuthoringOrchestrationExportedIntent": { - "description": "Represents an exported intent for an orchestration project.", - "required": [ - "category" - ], - "type": "object", - "properties": { - "orchestration": { - "description": "Specifies the behavior of this intent in the orchestration flow.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" - }, - "category": { - "description": "The intent category.", - "type": "string" - } - }, - "x-ms-client-name": "OrchestrationExportedIntent" - }, - "ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets": { - "description": "Represents the assets of an orchestration project.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" - } - ], - "properties": { - "intents": { - "description": "Represents the intents of the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedIntent" - } - }, - "utterances": { - "description": "Represents the utterances of the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedUtterance" - } - } - }, - "x-ms-discriminator-value": "Orchestration", - "x-ms-client-name": "OrchestrationExportedProjectAssets" - }, - "ConversationalAnalysisAuthoringOrchestrationExportedUtterance": { - "description": "Represents an utterance of an orchestration project.", - "required": [ - "text", - "intent" - ], - "type": "object", - "properties": { - "text": { - "description": "The utterance text.", - "type": "string" - }, - "language": { - "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "intent": { - "description": "The intent of the utterance.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "OrchestrationExportedUtterance" - }, - "ConversationalAnalysisAuthoringOrchestrationTargetProjectKind": { - "enum": [ - "Luis", - "Conversation", - "QuestionAnswering" - ], - "type": "string", - "x-ms-enum": { - "name": "OrchestrationTargetProjectKind", - "modelAsString": true - }, - "x-ms-client-name": "OrchestrationTargetProjectKind" - }, - "ConversationalAnalysisAuthoringPrebuiltEntities": { - "description": "Represents a list of the retrieved supported prebuilt entities.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The supported prebuilt entities.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntity" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "PrebuiltEntities" - }, - "ConversationalAnalysisAuthoringPrebuiltEntity": { - "description": "Represents a supported prebuilt entity.", - "required": [ - "category", - "description", - "examples" - ], - "type": "object", - "properties": { - "category": { - "description": "The prebuilt entity category.", - "type": "string" - }, - "description": { - "description": "The description.", - "type": "string" - }, - "examples": { - "description": "English examples for the entity.", - "type": "string" - } - }, - "x-ms-client-name": "PrebuiltEntity" - }, - "ConversationalAnalysisAuthoringProjectDeletionJobState": { - "description": "Represents the state of a project deletion job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "ProjectDeletionJobState" - }, - "ConversationalAnalysisAuthoringProjectDeployment": { - "description": "Represents a project deployment.", - "required": [ - "deploymentName", - "modelId", - "lastTrainedDateTime", - "lastDeployedDateTime", - "deploymentExpirationDate", - "modelTrainingConfigVersion" - ], - "type": "object", - "properties": { - "deploymentName": { - "description": "Represents deployment name.", - "type": "string" - }, - "modelId": { - "description": "Represents deployment modelId.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "Represents deployment last trained time.", - "type": "string" - }, - "lastDeployedDateTime": { - "format": "date-time", - "description": "Represents deployment last deployed time.", - "type": "string" - }, - "deploymentExpirationDate": { - "format": "date", - "description": "Represents deployment expiration date in the runtime.", - "type": "string" - }, - "modelTrainingConfigVersion": { - "description": "Represents model training config version.", - "type": "string" - } - }, - "x-ms-client-name": "ProjectDeployment" - }, - "ConversationalAnalysisAuthoringProjectDeployments": { - "description": "Represents a list of retrieved deployments.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved deployments.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectDeployments" - }, - "ConversationalAnalysisAuthoringProjectKind": { - "enum": [ - "Conversation", - "Orchestration" - ], - "type": "string", - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "A project to build natural language into apps, bots, and IoT devices." - }, - { - "value": "Orchestration", - "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." - } - ] - }, - "x-ms-client-name": "ProjectKind" - }, - "ConversationalAnalysisAuthoringProjectMetadata": { - "description": "Represents the metadata of a project.", - "required": [ - "createdDateTime", - "lastModifiedDateTime", - "projectKind", - "projectName", - "language" - ], - "type": "object", - "properties": { - "createdDateTime": { - "format": "date-time", - "description": "Represents the project creation datetime.", - "type": "string" - }, - "lastModifiedDateTime": { - "format": "date-time", - "description": "Represents the project creation datetime.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "Represents the project last trained datetime.", - "type": "string" - }, - "lastDeployedDateTime": { - "format": "date-time", - "description": "Represents the project last deployed datetime.", - "type": "string" - }, - "projectKind": { - "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" - }, - "settings": { - "description": "The project settings.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" - }, - "projectName": { - "description": "The new project name.", - "type": "string" - }, - "multilingual": { - "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" - }, - "description": { - "description": "The project description.", - "type": "string" - }, - "language": { - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "ProjectMetadata" - }, - "ConversationalAnalysisAuthoringProjectSettings": { - "description": "Represents the settings used to define the project behavior.", - "required": [ - "confidenceThreshold" - ], - "type": "object", - "properties": { - "confidenceThreshold": { - "format": "float", - "description": "The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to \"None\".", - "type": "number" - } - }, - "x-ms-client-name": "ProjectSettings" - }, - "ConversationalAnalysisAuthoringProjectsMetadata": { - "description": "Represents a list of retrieved projects' metadata.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of projects.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectsMetadata" - }, - "ConversationalAnalysisAuthoringProjectTrainedModel": { - "description": "Represents a trained model.", - "required": [ - "label", - "modelId", - "lastTrainedDateTime", - "lastTrainingDurationInSeconds", - "modelExpirationDate", - "modelTrainingConfigVersion" - ], - "type": "object", - "properties": { - "label": { - "description": "The trained model label.", - "type": "string" - }, - "modelId": { - "description": "The model ID.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "The last trained date time of the model.", - "type": "string" - }, - "lastTrainingDurationInSeconds": { - "format": "int32", - "description": "The duration of the model's last training request in seconds.", - "type": "integer" - }, - "modelExpirationDate": { - "format": "date", - "description": "The model expiration date.", - "type": "string" - }, - "modelTrainingConfigVersion": { - "description": "The model training config version.", - "type": "string" - } - }, - "x-ms-client-name": "ProjectTrainedModel" - }, - "ConversationalAnalysisAuthoringProjectTrainedModels": { - "description": "Represents a list of retrieved trained models.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved jobs.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectTrainedModels" - }, - "ConversationalAnalysisAuthoringStringIndexType": { - "enum": [ - "Utf16CodeUnit" - ], - "type": "string", - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - }, - "x-ms-client-name": "StringIndexType" - }, - "ConversationalAnalysisAuthoringSubTrainingJobState": { - "description": "Represents the detailed state of a training sub-operation.", - "required": [ - "percentComplete", - "status" - ], - "type": "object", - "properties": { - "percentComplete": { - "format": "int32", - "description": "Represents progress percentage.", - "type": "integer" - }, - "startDateTime": { - "format": "date-time", - "description": "Represents the start date time.", - "type": "string" - }, - "endDateTime": { - "format": "date-time", - "description": "Represents the end date time.", - "type": "string" - }, - "status": { - "description": "Represents the status of the sub-operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" - } - }, - "x-ms-client-name": "SubTrainingJobState" - }, - "ConversationalAnalysisAuthoringSupportedLanguage": { - "description": "Represents a supported language.", - "required": [ - "languageName", - "languageCode" - ], - "type": "object", - "properties": { - "languageName": { - "description": "The language name.", - "type": "string" - }, - "languageCode": { - "description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "SupportedLanguage" - }, - "ConversationalAnalysisAuthoringSupportedLanguages": { - "description": "Represents a list of retrieved languages.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of the languages.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguage" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "SupportedLanguages" - }, - "ConversationalAnalysisAuthoringSwapDeploymentsOptions": { - "description": "Represents the options for swapping two deployments together.", - "required": [ - "firstDeploymentName", - "secondDeploymentName" - ], - "type": "object", - "properties": { - "firstDeploymentName": { - "description": "Represents the first deployment name.", - "type": "string" - }, - "secondDeploymentName": { - "description": "Represents the second deployment name.", - "type": "string" - } - }, - "x-ms-client-name": "SwapDeploymentsOptions" - }, - "ConversationalAnalysisAuthoringTrainingConfigVersion": { - "description": "Represents a training config version.", - "required": [ - "trainingConfigVersion", - "modelExpirationDate" - ], - "type": "object", - "properties": { - "trainingConfigVersion": { - "description": "Represents the version of the config.", - "type": "string" - }, - "modelExpirationDate": { - "format": "date", - "description": "Represents the training config version expiration date.", - "type": "string" - } - }, - "x-ms-client-name": "TrainingConfigVersion" - }, - "ConversationalAnalysisAuthoringTrainingConfigVersions": { - "description": "Represents a list of training config versions.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of the training config versions.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersion" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "TrainingConfigVersions" - }, - "ConversationalAnalysisAuthoringTrainingJobOptions": { - "description": "Represents the options for starting a new training job.", - "required": [ - "modelLabel", - "trainingMode" - ], - "type": "object", - "properties": { - "modelLabel": { - "description": "Represents the output model label.", - "type": "string" - }, - "trainingConfigVersion": { - "description": "Represents training config version. By default, \"latest\" value is used which uses the latest released training config version.", - "type": "string" - }, - "trainingMode": { - "description": "Represents the mode of the training operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" - }, - "evaluationOptions": { - "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" - } - }, - "x-ms-client-name": "TrainingJobOptions" - }, - "ConversationalAnalysisAuthoringTrainingJobResult": { - "description": "Represents the output of a training job.", - "required": [ - "modelLabel", - "trainingConfigVersion", - "trainingStatus" - ], - "type": "object", - "properties": { - "modelLabel": { - "description": "Represents trained model label.", - "type": "string" - }, - "trainingConfigVersion": { - "description": "Represents training config version.", - "type": "string" - }, - "trainingMode": { - "description": "Represents the mode of the training operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" - }, - "trainingStatus": { - "description": "Represents the model training status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" - }, - "evaluationStatus": { - "description": "Represents model evaluation status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" - }, - "estimatedEndDateTime": { - "format": "date-time", - "description": "Represents the estimated end date time for training and evaluation.", - "type": "string" - } - }, - "x-ms-client-name": "TrainingJobResult" - }, - "ConversationalAnalysisAuthoringTrainingJobs": { - "description": "Represents a list of retrieved training jobs.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of jobs.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "TrainingJobs" - }, - "ConversationalAnalysisAuthoringTrainingJobState": { - "description": "Represents the state of a training job.", - "required": [ - "result" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "properties": { - "result": { - "description": "Represents training tasks detailed result.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobResult" - } - }, - "x-ms-client-name": "TrainingJobState" - }, - "ConversationalAnalysisAuthoringTrainingMode": { - "enum": [ - "advanced", - "standard" - ], - "type": "string", - "x-ms-enum": { - "name": "TrainingMode", - "modelAsString": true, - "values": [ - { - "value": "advanced", - "description": "Trains using fine-tuned neural network transformer models. Can train multilingual projects." - }, - { - "value": "standard", - "description": "Faster training times for quicker iterations." - } - ] - }, - "x-ms-client-name": "TrainingMode" - }, - "ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult": { - "description": "Represents the comparison between the expected and predicted entities for an utterance.", - "required": [ - "expectedEntities", - "predictedEntities" - ], - "type": "object", - "properties": { - "expectedEntities": { - "description": "Represents the expected entity labels.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" - } - }, - "predictedEntities": { - "description": "Represents the predicted entity labels.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" - } - } - }, - "x-ms-client-name": "UtteranceEntitiesEvaluationResult" - }, - "ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult": { - "description": "Represents the evaluation output of an entity label or prediction.", - "required": [ - "category", - "offset", - "length" - ], - "type": "object", - "properties": { - "category": { - "description": "Represents the entity category.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "Represents the entity offset index relative to the original text.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "Represents the entity length.", - "type": "integer" - } - }, - "x-ms-client-name": "UtteranceEntityEvaluationResult" - }, - "ConversationalAnalysisAuthoringUtteranceEvaluationResult": { - "description": "Represents the evaluation result for an utterance.", - "required": [ - "text", - "language", - "entitiesResult", - "intentsResult" - ], - "type": "object", - "properties": { - "text": { - "description": "Represents the utterance text.", - "type": "string" - }, - "language": { - "description": "Represents the utterance language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "entitiesResult": { - "description": "Represents the entities results for the utterance.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult" - }, - "intentsResult": { - "description": "Represents the intents results for the utterance.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult" - } - }, - "x-ms-client-name": "UtteranceEvaluationResult" - }, - "ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult": { - "description": "Represents the comparison between the expected and the predicted intent for an utterance.", - "required": [ - "expectedIntent", - "predictedIntent" - ], - "type": "object", - "properties": { - "expectedIntent": { - "description": "Represents the utterance's expected intent.", - "type": "string" - }, - "predictedIntent": { - "description": "Represents the utterance's predicted intent.", - "type": "string" - } - }, - "x-ms-client-name": "UtteranceIntentsEvaluationResult" - }, - "ConversationalAnalysisAuthoringWarning": { - "description": "Represents a warning that was encountered while executing the request.", - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "description": "The warning code.", - "type": "string" - }, - "message": { - "description": "The warning message.", - "type": "string" - } - }, - "x-ms-client-name": "Warning" - } - }, - "parameters": { - "ConversationalAnalysisAuthoringFormatQueryParameter": { - "in": "query", - "name": "format", - "description": "The format of the exported project file to use.", - "type": "string", - "enum": [ - "Conversation", - "Luis" - ], - "x-ms-enum": { - "name": "ExportedProjectFormat", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "Specifies the format for a conversational project." - }, - { - "value": "Luis", - "description": "Specifies the format for an application that was exported from LUIS." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "ConversationalAnalysisAuthoringStringIndexTypeQueryParameter": { - "in": "query", - "name": "stringIndexType", - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "required": true, - "type": "string", - "enum": [ - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "ConversationalAnalysisAuthoringJobIdPathParameter": { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ConversationalAnalysisAuthoringTrainedModelLabelPathParameter": { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model label.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ConversationalAnalysisAuthoringProjectKindQueryParameter": { - "in": "query", - "name": "projectKind", - "description": "The project kind.", - "required": true, - "type": "string", - "enum": [ - "Conversation", - "Orchestration" - ], - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "A project to build natural language into apps, bots, and IoT devices." - }, - { - "value": "Orchestration", - "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." - } - ] - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/analyzeconversations.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/analyzeconversations.json deleted file mode 100644 index 089bd6b1f0a1..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/analyzeconversations.json +++ /dev/null @@ -1,2322 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Analyze Conversations", - "description": "The language service conversations API is a suite of natural language processing (NLP) skills that can be used to analyze structured conversations (textual or spoken). The synchronous API in this suite accepts a request and mediates among multiple language projects, such as LUIS Generally Available, Question Answering, Conversational Language Understanding, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload.\n\n In some cases, this API needs to forward requests and responses between the caller and an upstream service. The asynchronous APIs in this suite enable tasks like Conversation Summarization and Conversational PII detection.", - "version": "2022-07-01-preview" - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/:analyze-conversations": { - "post": { - "operationId": "ConversationAnalysis_AnalyzeConversation", - "description": "Analyzes the input conversation utterance.", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "A single conversational task to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeConversationTask" - }, - "required": true - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The conversation analysis response.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationTaskResult" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" - } - } - } - }, - "x-ms-examples": { - "Conversation project result": { - "$ref": "./examples/conversations/SuccessfulAnalyzeConversations.json" - }, - "Arbitration result": { - "$ref": "./examples/conversations/SuccessfulAnalyzeConversationsArbitration.json" - }, - "Orchestrator direct target result": { - "$ref": "./examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json" - } - } - } - }, - "/analyze-conversations/jobs": { - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "description": "Submit a collection of conversations for analysis. Specify one or more unique tasks to be executed.", - "operationId": "AnalyzeConversation_SubmitJob", - "summary": "Submit analysis job for conversations", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "The collection of conversations to analyze and one or more tasks to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeConversationJobsInput" - }, - "required": true - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Conversational PII Analysis Job Request": { - "$ref": "./examples/conversations/SuccessfulConversationPIISubmit.json" - }, - "Successful Conversation Summarization Analysis Job Request": { - "$ref": "./examples/conversations/SuccessfulConversationSummarySubmit.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/analyze-conversations/jobs/{jobId}": { - "get": { - "produces": [ - "application/json" - ], - "description": "Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are succeeded, the job will transition to the succeeded state and results will be available for each task.", - "operationId": "AnalyzeConversation_JobStatus", - "summary": "Get analysis status and results", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/JobId" - }, - { - "$ref": "common.json#/parameters/ShowStats" - } - ], - "responses": { - "200": { - "description": "Analysis job status and metadata.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationJobState" - } - }, - "default": { - "description": "Error encountered.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Conversation PII Analysis Job Status Request": { - "$ref": "./examples/conversations/SuccessfulConversationPIITaskStatusRequest.json" - }, - "Successful Get Text Conversation Analysis Job Status Request": { - "$ref": "./examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json" - } - } - } - }, - "/analyze-conversations/jobs/{jobId}:cancel": { - "post": { - "produces": [ - "application/json" - ], - "description": "Cancel a long-running Text Analysis conversations job.", - "operationId": "AnalyzeConversation_CancelJob", - "summary": "Cancel a long-running Text Analysis conversations job", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/JobId" - } - ], - "responses": { - "202": { - "description": "Cancel Job request has been received.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Job Delete Request": { - "$ref": "./examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json" - } - }, - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "AnalyzeConversationTaskKind": { - "type": "string", - "description": "Enumeration of supported Conversation tasks.", - "enum": [ - "Conversation" - ], - "x-ms-enum": { - "name": "AnalyzeConversationTaskKind", - "modelAsString": true - } - }, - "AnalyzeConversationTaskResultsKind": { - "type": "string", - "description": "Enumeration of supported conversational task results", - "enum": [ - "ConversationResult" - ], - "x-ms-enum": { - "name": "AnalyzeConversationTaskResultsKind", - "modelAsString": true - } - }, - "AnalyzeConversationTask": { - "type": "object", - "description": "The base class of a conversation input task.", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationTaskKind" - } - } - }, - "AnalyzeConversationTaskResult": { - "type": "object", - "description": "The base class of a conversation task result.", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationTaskResultsKind" - } - } - }, - "ConversationalTask": { - "type": "object", - "description": "The input for a custom conversation task.", - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationTask" - } - ], - "properties": { - "analysisInput": { - "$ref": "#/definitions/ConversationAnalysisOptions" - }, - "parameters": { - "$ref": "#/definitions/ConversationTaskParameters" - } - }, - "x-ms-discriminator-value": "Conversation", - "required": [ - "analysisInput", - "parameters" - ] - }, - "ConversationTaskParameters": { - "type": "object", - "description": "Input parameters necessary for a Conversation task.", - "properties": { - "projectName": { - "type": "string", - "description": "The name of the project to use." - }, - "deploymentName": { - "type": "string", - "description": "The name of the deployment to use." - }, - "verbose": { - "type": "boolean", - "description": "If true, the service will return more detailed information in the response." - }, - "isLoggingEnabled": { - "type": "boolean", - "description": "If true, the service will keep the query for further review." - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - }, - "directTarget": { - "type": "string", - "description": "The name of a target project to forward the request to." - }, - "targetProjectParameters": { - "type": "object", - "description": "A dictionary representing the parameters for each target project.", - "additionalProperties": { - "$ref": "#/definitions/AnalysisParameters" - } - } - }, - "required": [ - "projectName", - "deploymentName" - ] - }, - "ConversationalTaskResult": { - "description": "The results of a Conversation task.", - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationTaskResult" - } - ], - "type": "object", - "properties": { - "result": { - "$ref": "#/definitions/AnalyzeConversationResult" - } - }, - "required": [ - "result" - ], - "x-ms-discriminator-value": "ConversationResult" - }, - "ConversationItemBase": { - "type": "object", - "description": "The abstract base for a user input formatted conversation (e.g., Text, Transcript).", - "properties": { - "id": { - "description": "The ID of a conversation item.", - "type": "string" - }, - "participantId": { - "description": "The participant ID of a conversation item.", - "type": "string" - }, - "language": { - "description": "The override language of a conversation item in BCP 47 language representation.", - "type": "string" - }, - "modality": { - "$ref": "#/definitions/Modality" - }, - "role": { - "type": "string", - "description": "The role of the participant.", - "enum": [ - "agent", - "customer", - "generic" - ], - "x-ms-enum": { - "name": "role", - "modelAsString": true - } - } - }, - "required": [ - "participantId", - "id" - ], - "additionalProperties": true - }, - "TextConversationItem": { - "type": "object", - "description": "The text modality of an input conversation.", - "allOf": [ - { - "$ref": "#/definitions/ConversationItemBase" - } - ], - "properties": { - "text": { - "description": "The text input", - "type": "string" - } - }, - "required": [ - "text" - ] - }, - "ConversationAnalysisOptions": { - "type": "object", - "description": "The input ConversationItem and its optional parameters", - "required": [ - "conversationItem" - ], - "properties": { - "conversationItem": { - "$ref": "#/definitions/ConversationItemBase" - } - } - }, - "AnalysisParameters": { - "type": "object", - "description": "This is the parameter set of either the Orchestration project itself or one of the target services.", - "required": [ - "targetProjectKind" - ], - "discriminator": "targetProjectKind", - "properties": { - "targetProjectKind": { - "type": "string", - "description": "The type of a target service.", - "enum": [ - "Luis", - "Conversation", - "QuestionAnswering", - "NonLinked" - ], - "x-ms-enum": { - "name": "targetProjectKind", - "modelAsString": true - } - }, - "apiVersion": { - "type": "string", - "description": "The API version to use when call a specific target service." - } - } - }, - "NoneLinkedTargetIntentResult": { - "type": "object", - "description": "A wrap up of non-linked intent response.", - "x-ms-discriminator-value": "NonLinked", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "$ref": "#/definitions/ConversationResult", - "description": "The actual response from a Conversation project." - } - } - }, - "LuisParameters": { - "description": "This is a set of request parameters for LUIS Generally Available projects.", - "x-ms-discriminator-value": "Luis", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "query": { - "type": "string", - "maxLength": 500, - "description": "The utterance to predict." - }, - "callingOptions": { - "type": "object", - "description": "This customizes how the service calls LUIS Generally Available projects.", - "$ref": "#/definitions/LuisCallingOptions" - } - }, - "additionalProperties": true - }, - "LuisCallingOptions": { - "description": "This customizes how the service calls LUIS Generally Available projects.", - "type": "object", - "properties": { - "verbose": { - "description": "Enable verbose response.", - "type": "boolean" - }, - "log": { - "description": "Save log to add in training utterances later.", - "type": "boolean" - }, - "show-all-intents": { - "description": "Set true to show all intents.", - "type": "boolean" - }, - "timezoneOffset": { - "type": "number", - "description": "The timezone offset for the location of the request." - }, - "spellCheck": { - "type": "boolean", - "description": "Enable spell checking." - }, - "bing-spell-check-subscription-key": { - "description": "The subscription key to use when enabling Bing spell check", - "type": "string" - } - } - }, - "ConversationParameters": { - "type": "object", - "description": "This is a set of request parameters for Customized Conversation projects.", - "x-ms-discriminator-value": "Conversation", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "callingOptions": { - "type": "object", - "$ref": "#/definitions/ConversationCallingOptions" - } - } - }, - "ConversationCallingOptions": { - "type": "object", - "description": "The option to set to call a Conversation project.", - "properties": { - "language": { - "description": "The language of the query in BCP 47 language representation..", - "type": "string" - }, - "verbose": { - "description": "If true, the service will return more detailed information.", - "type": "boolean" - }, - "isLoggingEnabled": { - "description": "If true, the query will be saved for customers to further review in authoring, to improve the model quality.", - "type": "boolean" - } - } - }, - "QuestionAnsweringParameters": { - "type": "object", - "description": "This is a set of request parameters for Question Answering knowledge bases.", - "x-ms-discriminator-value": "QuestionAnswering", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "callingOptions": { - "description": "The options sent to a Question Answering KB.", - "$ref": "common.json#/definitions/AnswersOptions" - } - } - }, - "AnalyzeConversationResult": { - "type": "object", - "description": "Represents a conversation analysis response.", - "required": [ - "query", - "prediction" - ], - "properties": { - "query": { - "type": "string", - "description": "The conversation utterance given by the caller." - }, - "detectedLanguage": { - "type": "string", - "description": "The system detected language for the query in BCP 47 language representation.." - }, - "prediction": { - "description": "The prediction result of a conversation project.", - "$ref": "#/definitions/BasePrediction" - } - } - }, - "BasePrediction": { - "type": "object", - "description": "This is the base class of prediction", - "required": [ - "projectKind" - ], - "discriminator": "projectKind", - "properties": { - "projectKind": { - "type": "string", - "description": "The type of the project.", - "enum": [ - "Conversation", - "Orchestration" - ], - "x-ms-enum": { - "name": "projectKind", - "modelAsString": true - } - }, - "topIntent": { - "type": "string", - "description": "The intent with the highest score." - } - } - }, - "OrchestrationPrediction": { - "type": "object", - "description": "This represents the prediction result of an Orchestration project.", - "x-ms-discriminator-value": "Orchestration", - "required": [ - "intents" - ], - "allOf": [ - { - "$ref": "#/definitions/BasePrediction" - } - ], - "properties": { - "intents": { - "description": "A dictionary that contains all intents. A key is an intent name and a value is its confidence score and target type. The top intent's value also contains the actual response from the target project.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TargetIntentResult" - } - } - } - }, - "TargetIntentResult": { - "type": "object", - "description": "This is the base class of an intent prediction", - "discriminator": "targetProjectKind", - "required": [ - "confidenceScore", - "targetProjectKind" - ], - "properties": { - "targetProjectKind": { - "type": "string", - "description": "This discriminator property specifies the type of the target project that returns the response.", - "enum": [ - "Luis", - "Conversation", - "QuestionAnswering", - "NonLinked" - ], - "x-ms-enum": { - "name": "targetProjectKind", - "modelAsString": true - } - }, - "apiVersion": { - "type": "string", - "description": "The API version used to call a target service." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidence", - "description": "The prediction score and it ranges from 0.0 to 1.0.", - "minimum": 0, - "maximum": 1 - } - } - }, - "ConversationTargetIntentResult": { - "type": "object", - "description": "A wrap up of Conversation project response.", - "x-ms-discriminator-value": "Conversation", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "type": "object", - "$ref": "#/definitions/ConversationResult", - "description": "The actual response from a Conversation project." - } - } - }, - "ConversationResult": { - "type": "object", - "description": "The response returned by a Conversation project.", - "required": [ - "query" - ], - "properties": { - "query": { - "description": "The same query given in request.", - "type": "string" - }, - "detectedLanguage": { - "description": "The detected language from the query in BCP 47 language representation..", - "type": "string" - }, - "prediction": { - "description": "The predicted result for the query.", - "$ref": "#/definitions/ConversationPrediction" - } - } - }, - "ConversationPrediction": { - "type": "object", - "description": "Represents the prediction section of a Conversation project.", - "x-ms-discriminator-value": "Conversation", - "required": [ - "intents", - "entities" - ], - "allOf": [ - { - "$ref": "#/definitions/BasePrediction" - } - ], - "properties": { - "intents": { - "description": "The intent classification results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationIntent" - } - }, - "entities": { - "description": "The entity extraction results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationEntity" - } - } - } - }, - "ConversationIntent": { - "type": "object", - "description": "The intent classification result of a Conversation project.", - "required": [ - "category", - "confidenceScore" - ], - "properties": { - "category": { - "description": "A predicted class.", - "type": "string" - }, - "confidenceScore": { - "format": "float", - "x-ms-client-name": "confidence", - "description": "The confidence score of the class from 0.0 to 1.0.", - "type": "number", - "minimum": 0, - "maximum": 1 - } - } - }, - "ConversationEntity": { - "type": "object", - "description": "The entity extraction result of a Conversation project.", - "required": [ - "category", - "text", - "offset", - "length", - "confidenceScore" - ], - "properties": { - "category": { - "description": "The entity category.", - "type": "string" - }, - "text": { - "description": "The predicted entity text.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "The starting index of this entity in the query.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "The length of the text.", - "type": "integer" - }, - "confidenceScore": { - "format": "float", - "x-ms-client-name": "confidence", - "description": "The entity confidence score.", - "type": "number" - }, - "resolutions": { - "description": "The collection of entity resolution objects.", - "type": "array", - "items": { - "$ref": "#/definitions/BaseResolution" - } - }, - "extraInformation": { - "description": "The collection of entity extra information objects.", - "type": "array", - "items": { - "$ref": "#/definitions/BaseExtraInformation" - } - } - } - }, - "BaseExtraInformation": { - "description": "The abstract base object for entity extra information.", - "type": "object", - "discriminator": "extraInformationKind", - "properties": { - "extraInformationKind": { - "description": "The extra information object kind.", - "type": "string", - "enum": [ - "EntitySubtype", - "ListKey" - ], - "x-ms-enum": { - "name": "ExtraInformationKind", - "modelAsString": true - } - } - }, - "required": [ - "extraInformationKind" - ] - }, - "EntitySubtype": { - "description": "The concrete entity Subtype model of extra information.", - "allOf": [ - { - "$ref": "#/definitions/BaseExtraInformation" - } - ], - "type": "object", - "x-ms-discriminator-value": "EntitySubtype", - "properties": { - "value": { - "type": "string", - "description": "The Subtype of an extracted entity type." - } - } - }, - "ListKey": { - "description": "The list key extra data kind.", - "allOf": [ - { - "$ref": "#/definitions/BaseExtraInformation" - } - ], - "type": "object", - "x-ms-discriminator-value": "ListKey", - "properties": { - "key": { - "type": "string", - "description": "The canonical form of the extracted entity." - } - } - }, - "BaseResolution": { - "description": "The abstract base class for entity resolutions.", - "type": "object", - "discriminator": "resolutionKind", - "properties": { - "resolutionKind": { - "description": "The entity resolution object kind.", - "type": "string", - "enum": [ - "BooleanResolution", - "DateTimeResolution", - "NumberResolution", - "OrdinalResolution", - "SpeedResolution", - "WeightResolution", - "LengthResolution", - "VolumeResolution", - "AreaResolution", - "AgeResolution", - "InformationResolution", - "TemperatureResolution", - "CurrencyResolution", - "NumericRangeResolution", - "TemporalSpanResolution" - ], - "x-ms-enum": { - "name": "ResolutionKind", - "modelAsString": true - } - } - }, - "required": [ - "resolutionKind" - ] - }, - "QuantityResolution": { - "description": "Represents resolutions for quantities.", - "type": "object", - "properties": { - "value": { - "type": "number", - "format": "double", - "description": "The numeric value that the extracted text denotes." - } - }, - "required": [ - "value" - ] - }, - "AgeResolution": { - "description": "Represents the Age entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "AgeResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Year", - "Month", - "Week", - "Day" - ], - "x-ms-enum": { - "name": "AgeUnit", - "modelAsString": true - }, - "description": "The Age Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "VolumeResolution": { - "description": "Represents the volume entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "VolumeResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "CubicMeter", - "CubicCentimeter", - "CubicMillimeter", - "Hectoliter", - "Decaliter", - "Liter", - "Centiliter", - "Milliliter", - "CubicYard", - "CubicInch", - "CubicFoot", - "CubicMile", - "FluidOunce", - "Teaspoon", - "Tablespoon", - "Pint", - "Quart", - "Cup", - "Gill", - "Pinch", - "FluidDram", - "Barrel", - "Minim", - "Cord", - "Peck", - "Bushel", - "Hogshead" - ], - "x-ms-enum": { - "name": "VolumeUnit", - "modelAsString": true - }, - "description": "The Volume Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "SpeedResolution": { - "description": "Represents the speed entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "SpeedResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "MetersPerSecond", - "KilometersPerHour", - "KilometersPerMinute", - "KilometersPerSecond", - "MilesPerHour", - "Knot", - "FootPerSecond", - "FootPerMinute", - "YardsPerMinute", - "YardsPerSecond", - "MetersPerMillisecond", - "CentimetersPerMillisecond", - "KilometersPerMillisecond" - ], - "x-ms-enum": { - "name": "SpeedUnit", - "modelAsString": true - }, - "description": "The speed Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "AreaResolution": { - "description": "Represents the area entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "AreaResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "SquareKilometer", - "SquareHectometer", - "SquareDecameter", - "SquareDecimeter", - "SquareMeter", - "SquareCentimeter", - "SquareMillimeter", - "SquareInch", - "SquareFoot", - "SquareMile", - "SquareYard", - "Acre" - ], - "x-ms-enum": { - "name": "AreaUnit", - "modelAsString": true - }, - "description": "The area Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "LengthResolution": { - "description": "Represents the length entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "LengthResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Kilometer", - "Hectometer", - "Decameter", - "Meter", - "Decimeter", - "Centimeter", - "Millimeter", - "Micrometer", - "Nanometer", - "Picometer", - "Mile", - "Yard", - "Inch", - "Foot", - "LightYear", - "Pt" - ], - "x-ms-enum": { - "name": "LengthUnit", - "modelAsString": true - }, - "description": "The length Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "InformationResolution": { - "description": "Represents the information (data) entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "InformationResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Bit", - "Kilobit", - "Megabit", - "Gigabit", - "Terabit", - "Petabit", - "Byte", - "Kilobyte", - "Megabyte", - "Gigabyte", - "Terabyte", - "Petabyte" - ], - "x-ms-enum": { - "name": "InformationUnit", - "modelAsString": true - }, - "description": "The information (data) Unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "TemperatureResolution": { - "description": "Represents the temperature entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "TemperatureResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Fahrenheit", - "Kelvin", - "Rankine", - "Celsius" - ], - "x-ms-enum": { - "name": "TemperatureUnit", - "modelAsString": true - }, - "description": "The temperature Unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "WeightResolution": { - "description": "Represents the weight entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "WeightResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Kilogram", - "Gram", - "Milligram", - "Gallon", - "MetricTon", - "Ton", - "Pound", - "Ounce", - "Grain", - "PennyWeight", - "LongTonBritish", - "ShortTonUS", - "ShortHundredWeightUS", - "Stone", - "Dram" - ], - "x-ms-enum": { - "name": "WeightUnit", - "modelAsString": true - }, - "description": "The weight Unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "CurrencyResolution": { - "description": "Represents the currency entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "CurrencyResolution", - "properties": { - "ISO4217": { - "type": "string", - "description": "The alphabetic code based on another ISO standard, ISO 3166, which lists the codes for country names. The first two letters of the ISO 4217 three-letter code are the same as the code for the country name, and, where possible, the third letter corresponds to the first letter of the currency name." - }, - "value": { - "type": "number", - "format": "double", - "description": "The money amount captured in the extracted entity" - }, - "unit": { - "type": "string", - "description": "The unit of the amount captured in the extracted entity" - } - }, - "required": [ - "value", - "unit" - ] - }, - "BooleanResolution": { - "description": "A resolution for boolean expressions", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "BooleanResolution", - "properties": { - "value": { - "type": "boolean" - } - }, - "required": [ - "value" - ] - }, - "DateTimeResolution": { - "description": "A resolution for datetime entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "DateTimeResolution", - "properties": { - "timex": { - "$ref": "#/definitions/TimeExpression" - }, - "dateTimeSubKind": { - "type": "string", - "enum": [ - "Time", - "Date", - "DateTime", - "Duration", - "Set" - ], - "x-ms-enum": { - "name": "DateTimeSubKind", - "modelAsString": true - }, - "description": "The DateTime SubKind" - }, - "value": { - "type": "string", - "description": "The actual time that the extracted text denote." - }, - "modifier": { - "$ref": "#/definitions/TemporalModifier" - } - }, - "required": [ - "timex", - "dateTimeSubKind", - "value" - ] - }, - "NumberResolution": { - "description": "A resolution for numeric entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "NumberResolution", - "properties": { - "numberKind": { - "type": "string", - "enum": [ - "Integer", - "Decimal", - "Power", - "Fraction", - "Percent", - "Unspecified" - ], - "x-ms-enum": { - "name": "NumberKind", - "modelAsString": true - }, - "description": "The type of the extracted number entity." - }, - "value": { - "type": "string", - "description": "A numeric representation of what the extracted text denotes." - } - }, - "required": [ - "numberKind", - "value" - ] - }, - "OrdinalResolution": { - "description": "A resolution for ordinal numbers entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "OrdinalResolution", - "properties": { - "offset": { - "type": "string", - "description": "The offset With respect to the reference (e.g., offset = -1 in \"show me the second to last\"" - }, - "relativeTo": { - "type": "string", - "enum": [ - "Current", - "End", - "Start" - ], - "x-ms-enum": { - "name": "RelativeTo", - "modelAsString": true - }, - "description": "The reference point that the ordinal number denotes." - }, - "value": { - "type": "string", - "description": "A simple arithmetic expression that the ordinal denotes." - } - }, - "required": [ - "offset", - "relativeTo", - "value" - ] - }, - "TemporalSpanResolution": { - "description": "represents the resolution of a date and/or time span.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "TemporalSpanResolution", - "properties": { - "begin": { - "$ref": "#/definitions/TimeExpression" - }, - "end": { - "$ref": "#/definitions/TimeExpression" - }, - "duration": { - "type": "string", - "description": "An optional duration value formatted based on the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)" - }, - "modifier": { - "$ref": "#/definitions/TemporalModifier" - } - } - }, - "NumericRangeResolution": { - "description": "represents the resolution of numeric intervals.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "NumericRangeResolution", - "properties": { - "rangeKind": { - "type": "string", - "enum": [ - "Number", - "Speed", - "Weight", - "Length", - "Volume", - "Area", - "Age", - "Information", - "Temperature", - "Currency" - ], - "x-ms-enum": { - "name": "RangeKind", - "modelAsString": true - }, - "description": "The kind of range that the resolution object represents." - }, - "minimum": { - "type": "number", - "format": "double", - "description": "The beginning value of the interval." - }, - "maximum": { - "type": "number", - "format": "double", - "description": "The ending value of the interval." - } - }, - "required": [ - "rangeKind", - "minimum", - "maximum" - ] - }, - "TemporalModifier": { - "type": "string", - "description": "An optional modifier of a date/time instance.", - "enum": [ - "AfterApprox", - "Before", - "BeforeStart", - "Approx", - "ReferenceUndefined", - "SinceEnd", - "AfterMid", - "Start", - "After", - "BeforeEnd", - "Until", - "End", - "Less", - "Since", - "AfterStart", - "BeforeApprox", - "Mid", - "More" - ], - "x-ms-enum": { - "name": "TemporalModifier", - "modelAsString": true - } - }, - "TimeExpression": { - "type": "string", - "description": "An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)" - }, - "LuisTargetIntentResult": { - "type": "object", - "description": "It is a wrap up of LUIS Generally Available response.", - "x-ms-discriminator-value": "Luis", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "type": "object", - "description": "The actual response from a LUIS Generally Available application." - } - } - }, - "QuestionAnsweringTargetIntentResult": { - "type": "object", - "description": "It is a wrap up a Question Answering KB response.", - "x-ms-discriminator-value": "QuestionAnswering", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "description": "The generated answer by a Question Answering KB.", - "$ref": "common.json#/definitions/AnswersResult" - } - } - }, - "AnalyzeConversationJobsInput": { - "type": "object", - "properties": { - "displayName": { - "description": "Optional display name for the analysis job.", - "type": "string" - }, - "analysisInput": { - "$ref": "#/definitions/MultiLanguageConversationAnalysisInput" - }, - "tasks": { - "description": "The set of tasks to execute on the input conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeConversationLROTask" - } - } - }, - "required": [ - "analysisInput", - "tasks" - ] - }, - "AnalyzeConversationLROTask": { - "type": "object", - "description": "The base class for an long running conversation input task.", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationLROTaskKind" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskIdentifier" - } - ] - }, - "AnalyzeConversationLROTaskKind": { - "type": "string", - "description": "Enumeration of supported analysis tasks on a collection of conversations.", - "enum": [ - "ConversationalPIITask", - "ConversationalSummarizationTask" - ], - "x-ms-enum": { - "name": "AnalyzeConversationLROTaskKind", - "modelAsString": true - } - }, - "AnalyzeConversationResultsKind": { - "type": "string", - "description": "Enumeration of supported Conversation Analysis task results.", - "enum": [ - "ConversationalPIIResults", - "ConversationalSummarizationResults" - ], - "x-ms-enum": { - "name": "AnalyzeConversationResultsKind", - "modelAsString": true - } - }, - "AnalyzeConversationPIITask": { - "type": "object", - "description": "Task definition for a PII redaction in conversations.", - "properties": { - "parameters": { - "$ref": "#/definitions/ConversationPIITaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationLROTask" - } - ], - "x-ms-discriminator-value": "ConversationalPIITask" - }, - "ConversationPIIItemResult": { - "type": "object", - "required": [ - "id", - "redactedContent", - "entities" - ], - "properties": { - "id": { - "type": "string" - }, - "redactedContent": { - "type": "object", - "$ref": "#/definitions/RedactedTranscriptContent" - }, - "entities": { - "type": "array", - "items": { - "$ref": "#/definitions/Entity" - } - } - } - }, - "MultiLanguageConversationAnalysisInput": { - "type": "object", - "required": [ - "conversations" - ], - "properties": { - "conversations": { - "type": "array", - "items": { - "$ref": "#/definitions/Conversation" - } - } - } - }, - "Conversation": { - "type": "object", - "description": "A complete ordered set of utterances (spoken or written), by one or more speakers to be used for analysis.", - "discriminator": "modality", - "required": [ - "id", - "language", - "modality" - ], - "properties": { - "id": { - "description": "Unique identifier for the conversation.", - "type": "string" - }, - "language": { - "description": "The language of the conversation item in BCP-47 format.", - "type": "string" - }, - "modality": { - "$ref": "#/definitions/Modality" - }, - "domain": { - "$ref": "#/definitions/ConversationDomain" - } - } - }, - "Modality": { - "type": "string", - "description": "Enumeration of supported conversational modalities.", - "enum": [ - "transcript", - "text" - ], - "x-ms-enum": { - "name": "InputModality", - "modelAsString": true - } - }, - "ConversationDomain": { - "type": "string", - "description": "Enumeration of supported conversational domains.", - "enum": [ - "finance", - "healthcare", - "generic" - ], - "x-ms-enum": { - "name": "ConversationDomain", - "modelAsString": true - } - }, - "TextConversation": { - "type": "object", - "x-ms-discriminator-value": "text", - "required": [ - "conversationItems" - ], - "allOf": [ - { - "$ref": "#/definitions/Conversation" - } - ], - "properties": { - "conversationItems": { - "description": "Ordered list of text conversation items in the conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/TextConversationItem" - } - } - } - }, - "TranscriptConversation": { - "type": "object", - "x-ms-discriminator-value": "transcript", - "required": [ - "conversationItems" - ], - "allOf": [ - { - "$ref": "#/definitions/Conversation" - } - ], - "properties": { - "conversationItems": { - "description": "Ordered list of transcript conversation items in the conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/TranscriptConversationItem" - } - } - } - }, - "TranscriptConversationItem": { - "type": "object", - "description": "Additional properties for supporting transcript conversation.", - "required": [ - "text", - "lexical", - "itn", - "maskedItn" - ], - "allOf": [ - { - "$ref": "#/definitions/ConversationItemBase" - } - ], - "properties": { - "itn": { - "type": "string", - "description": "Inverse Text Normalization representation of input. The inverse-text-normalized form is the recognized text from Microsoft’s Speech to Text API, with phone numbers, numbers, abbreviations, and other transformations applied." - }, - "maskedItn": { - "type": "string", - "description": "The Inverse Text Normalized format with profanity masking applied." - }, - "text": { - "type": "string", - "description": "The display form of the recognized text from speech to text API, with punctuation and capitalization added." - }, - "lexical": { - "type": "string", - "description": "The lexical form of the recognized text from speech to text API with the actual words recognized." - }, - "audioTimings": { - "type": "array", - "description": "The list of word level audio timing information", - "items": { - "$ref": "#/definitions/WordLevelTiming" - } - } - } - }, - "RedactedTranscriptContent": { - "type": "object", - "description": "The transcript content response generated by the service with all necessary personally identifiable information redacted.", - "properties": { - "itn": { - "type": "string", - "description": "The redacted output for inverse text normalized format input." - }, - "maskedItn": { - "type": "string", - "description": "The redacted output for masked inverse text normalized format input." - }, - "text": { - "type": "string", - "description": "The redacted output for text (Microsoft's Speech to Text 'display') format input." - }, - "lexical": { - "type": "string", - "description": "The redacted output for lexical format input." - }, - "audioTimings": { - "type": "array", - "description": "The list of redacted audio segments.", - "items": { - "$ref": "#/definitions/AudioTiming" - } - } - } - }, - "WordLevelTiming": { - "type": "object", - "description": "Word level timing information generated by the speech to text API. The words in this object should have 1:1 correspondence with the 'lexical' input to allow for audio redaction.", - "properties": { - "word": { - "type": "string", - "description": "The word recognized." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AudioTiming" - } - ] - }, - "AudioTiming": { - "type": "object", - "description": "The audio timing information.", - "properties": { - "offset": { - "description": "Offset from start of speech audio, in ticks. 1 tick = 100 ns.", - "type": "integer", - "format": "int64" - }, - "duration": { - "description": "Duration of word articulation, in ticks. 1 tick = 100 ns.", - "type": "integer", - "format": "int64" - } - } - }, - "Entity": { - "type": "object", - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ], - "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "type": "string", - "description": "Entity type." - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub type." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted entity." - } - } - }, - "AnalyzeConversationConversationPIIResult": { - "type": "object", - "description": "Result from the personally identifiable information detection and redaction operation performed on a list of conversations.", - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationJobResult" - } - ], - "properties": { - "results": { - "$ref": "#/definitions/ConversationPIIResults" - } - }, - "required": [ - "results" - ], - "x-ms-discriminator-value": "ConversationalPIIResults" - }, - "ConversationPIIResults": { - "type": "object", - "description": "The result from PII detection and redaction operation for each conversation.", - "required": [ - "conversations" - ], - "properties": { - "conversations": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "#/definitions/ConversationPIIResult" - }, - { - "$ref": "#/definitions/ConversationResultBase" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ] - }, - "ConversationPIIResult": { - "type": "object", - "description": "The result from PII detection and redaction operation for each conversation.", - "required": [ - "conversationItems" - ], - "properties": { - "conversationItems": { - "description": "Enumeration of PII detection and redaction operation results for all the conversation items in a conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationPIIItemResult" - } - } - } - }, - "ConversationPIITaskParameters": { - "type": "object", - "description": "Supported parameters for a Conversational PII detection and redaction task.", - "properties": { - "piiCategories": { - "$ref": "#/definitions/ConversationPIICategories" - }, - "includeAudioRedaction": { - "type": "boolean", - "description": "Flag to indicate if audio redaction is requested. By default audio redaction will not be performed.", - "default": false - }, - "redactionSource": { - "type": "string", - "description": "For transcript conversations, this parameter provides information regarding which content type (ITN, Text, Lexical, Masked ITN) should be used for entity detection. The details of the entities detected - like the offset, length and the text itself - will correspond to the text type selected here.", - "$ref": "#/definitions/TranscriptContentType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "ConversationPIICategories": { - "description": "Describes the PII categories to return for detection. If not provided, 'default' categories will be returned which will vary with the language.", - "items": { - "type": "string", - "x-ms-enum": { - "name": "ConversationPIICategory", - "modelAsString": true - }, - "enum": [ - "Address", - "CreditCardNumber", - "Email", - "Name", - "NumericIdentifier", - "PhoneNumber", - "USSocialSecurityNumber", - "Miscellaneous", - "All", - "Default" - ] - }, - "type": "array", - "uniqueItems": true - }, - "TranscriptContentType": { - "type": "string", - "description": "Enumeration of supported transcript content types.", - "enum": [ - "lexical", - "itn", - "maskedItn", - "text" - ], - "x-ms-enum": { - "name": "TranscriptContentType", - "modelAsString": true - } - }, - "AnalyzeConversationSummarizationTask": { - "type": "object", - "description": "Task definition for conversational summarization.", - "properties": { - "parameters": { - "$ref": "#/definitions/ConversationSummarizationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationLROTask" - } - ], - "x-ms-discriminator-value": "ConversationalSummarizationTask" - }, - "ConversationSummarizationTaskParameters": { - "type": "object", - "description": "Supported parameters for an conversational summarization task.", - "required": [ - "summaryAspects" - ], - "properties": { - "summaryAspects": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "issue", - "resolution" - ], - "x-ms-enum": { - "name": "SummaryAspect", - "modelAsString": true - } - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "AnalyzeConversationSummarizationResult": { - "type": "object", - "description": "Result for the summarization task on the conversation.", - "properties": { - "results": { - "$ref": "#/definitions/SummaryResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationJobResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "ConversationalSummarizationResults" - }, - "SummaryResult": { - "type": "object", - "required": [ - "conversations" - ], - "properties": { - "conversations": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "#/definitions/ConversationsSummaryResult" - }, - { - "$ref": "#/definitions/ConversationResultBase" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ] - }, - "ConversationsSummaryResult": { - "type": "object", - "required": [ - "summaries" - ], - "properties": { - "summaries": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "#/definitions/SummaryResultItem" - } - ] - } - } - } - }, - "SummaryResultItem": { - "type": "object", - "properties": { - "aspect": { - "type": "string" - }, - "text": { - "type": "string" - } - }, - "required": [ - "aspect", - "text" - ] - }, - "AnalyzeConversationJobState": { - "description": "Contains the status of the analyze conversations job submitted along with related statistics.", - "allOf": [ - { - "$ref": "common.json#/definitions/JobState" - }, - { - "$ref": "#/definitions/ConversationTasksState" - }, - { - "$ref": "#/definitions/AnalyzeConversationJobStatistics" - } - ] - }, - "AnalyzeConversationJobStatistics": { - "description": "Contains the statistics for the job submitted.", - "properties": { - "statistics": { - "$ref": "#/definitions/ConversationRequestStatistics" - } - }, - "type": "object" - }, - "ConversationTasksState": { - "description": "Contains the state for the tasks being executed as part of the analyze conversation job submitted.", - "properties": { - "tasks": { - "properties": { - "completed": { - "description": "Count of tasks completed successfully.", - "type": "integer", - "format": "int32" - }, - "failed": { - "description": "Count of tasks that failed.", - "type": "integer", - "format": "int32" - }, - "inProgress": { - "description": "Count of tasks in progress currently.", - "type": "integer", - "format": "int32" - }, - "total": { - "description": "Total count of tasks submitted as part of the job.", - "type": "integer", - "format": "int32" - }, - "items": { - "description": "List of results from tasks (if available).", - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeConversationJobResult" - } - } - }, - "required": [ - "total", - "completed", - "failed", - "inProgress" - ], - "type": "object" - } - }, - "required": [ - "tasks" - ], - "type": "object" - }, - "AnalyzeConversationJobResult": { - "type": "object", - "description": "Container for results for all tasks in the conversation job.", - "discriminator": "kind", - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationResultsKind" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskState" - }, - { - "$ref": "common.json#/definitions/TaskIdentifier" - } - ], - "required": [ - "kind" - ] - }, - "ConversationResultBase": { - "type": "object", - "description": "Shared attributes for all conversational task results.", - "required": [ - "id", - "warnings" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique, non-empty conversation identifier." - }, - "warnings": { - "type": "array", - "description": "Warnings encountered while processing document.", - "items": { - "$ref": "common.json#/definitions/InputWarning" - } - }, - "statistics": { - "$ref": "#/definitions/ConversationStatistics" - } - } - }, - "ConversationStatistics": { - "type": "object", - "description": "If showStats=true was specified in the request this field will contain information about the conversation payload.", - "required": [ - "transactionsCount" - ], - "properties": { - "transactionsCount": { - "type": "integer", - "format": "int32", - "description": "Number of text units for the request." - } - } - }, - "ConversationRequestStatistics": { - "type": "object", - "description": "if showStats=true was specified in the request this field will contain information about the request payload.", - "required": [ - "conversationsCount", - "validConversationsCount", - "erroneousConversationsCount" - ], - "properties": { - "conversationsCount": { - "type": "integer", - "format": "int32", - "description": "Number of conversations submitted in the request." - }, - "validConversationsCount": { - "type": "integer", - "format": "int32", - "description": "Number of conversations documents. This excludes empty, over-size limit or non-supported languages documents." - }, - "erroneousConversationsCount": { - "type": "integer", - "format": "int32", - "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/RequestStatistics" - } - ] - } - }, - "parameters": { - "ConversationAnalysisOptions": { - "name": "ConversationAnalysisOptions", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationAnalysisOptions" - }, - "description": "Post body of the request.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/analyzetext-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/analyzetext-authoring.json deleted file mode 100644 index 23cb97ef516f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/analyzetext-authoring.json +++ /dev/null @@ -1,2972 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Analyze Text Authoring", - "version": "2022-07-01-preview", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview." - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/authoring/analyze-text/projects": { - "get": { - "description": "Lists the existing projects.", - "operationId": "TextAnalysisAuthoring_ListProjects", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of projects.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectsMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Projects": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListProjects.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/{projectName}": { - "patch": { - "description": "Creates a new project or updates an existing one.", - "operationId": "TextAnalysisAuthoring_CreateProject", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The project parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringCreateProjectOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of the updated project, if it already exists.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" - } - }, - "201": { - "description": "The metadata of the created project.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Create Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulCreateProject.json" - } - } - }, - "get": { - "description": "Gets the details of a project.", - "operationId": "TextAnalysisAuthoring_GetProject", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of the project.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetProject.json" - } - } - }, - "delete": { - "description": "Deletes a project.", - "operationId": "TextAnalysisAuthoring_DeleteProject", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/:export": { - "post": { - "description": "Triggers a job to export a project's data.", - "operationId": "TextAnalysisAuthoring_Export", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringStringIndexTypeQueryParameter" - }, - { - "in": "query", - "name": "assetKind", - "description": "Kind of asset to export.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Export Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulExportProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/:import": { - "post": { - "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", - "operationId": "TextAnalysisAuthoring_Import", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The project data to import.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProject" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Import Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulImportProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/:train": { - "post": { - "description": "Triggers a training job for a project.", - "operationId": "TextAnalysisAuthoring_Train", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The training input parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Train Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulTrainProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments": { - "get": { - "description": "Lists the deployments belonging to a project.", - "operationId": "TextAnalysisAuthoring_ListDeployments", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all deployments.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployments" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Deployments": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListDeployments.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/:swap": { - "post": { - "description": "Swaps two existing deployments with each other.", - "operationId": "TextAnalysisAuthoring_SwapDeployments", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The job object to swap two deployments.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringSwapDeploymentsOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Swap Deployments": { - "$ref": "./examples/analyzetext-authoring/SuccessfulSwapDeployments.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}": { - "get": { - "description": "Gets the details of a deployment.", - "operationId": "TextAnalysisAuthoring_GetDeployment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The Deployment info.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployment" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Deployment": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetDeployment.json" - } - } - }, - "put": { - "description": "Creates a new deployment or replaces an existing one.", - "operationId": "TextAnalysisAuthoring_DeployProject", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The new deployment info.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringCreateDeploymentOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Deploy Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeployProject.json" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "description": "Deletes a project deployment.", - "operationId": "TextAnalysisAuthoring_DeleteDeployment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Deployment": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteDeployment.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing deployment job.", - "operationId": "TextAnalysisAuthoring_GetDeploymentStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The deployment job result.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringDeploymentJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Deployment Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing swap deployment job.", - "operationId": "TextAnalysisAuthoring_GetSwapDeploymentsStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The swap deployment job result.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringDeploymentJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Swap Deployments Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}": { - "get": { - "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", - "operationId": "TextAnalysisAuthoring_GetExportStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The status of the long running operation.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringExportProjectJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Export Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetExportStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}": { - "get": { - "description": "Gets the status for an import.", - "operationId": "TextAnalysisAuthoring_GetImportStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The details of the long running operation.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringImportProjectJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Import Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetImportStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models": { - "get": { - "description": "Lists the trained models belonging to a project.", - "operationId": "TextAnalysisAuthoring_ListTrainedModels", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all trained models.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModels" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Models": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListModels.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}": { - "get": { - "description": "Gets the details of a trained model.", - "operationId": "TextAnalysisAuthoring_GetTrainedModel", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Trained model info", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModel" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetModel.json" - } - } - }, - "delete": { - "description": "Deletes an existing trained model.", - "operationId": "TextAnalysisAuthoring_DeleteTrainedModel", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "204": { - "description": "Deleted successfully." - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Model": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteModel.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { - "get": { - "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", - "operationId": "TextAnalysisAuthoring_GetModelEvaluationResults", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringStringIndexTypeQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of the evaluation results.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationResults" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model Evaluation": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { - "get": { - "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", - "operationId": "TextAnalysisAuthoring_GetModelEvaluationSummary", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all evaluation results.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model Evaluation Summary": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/train/jobs": { - "get": { - "description": "Lists the non-expired training jobs created for a project.", - "operationId": "TextAnalysisAuthoring_ListTrainingJobs", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of the training jobs.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobs" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Training Jobs": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListTrainingJobs.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}": { - "get": { - "description": "Gets the status for a training job.", - "operationId": "TextAnalysisAuthoring_GetTrainingStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The training job result.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Train Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetTrainStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}/:cancel": { - "post": { - "description": "Triggers a cancellation for a running training job.", - "operationId": "TextAnalysisAuthoring_CancelTrainingJob", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the job cancellation.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Cancel Training Job": { - "$ref": "./examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/global/deletion-jobs/{jobId}": { - "get": { - "description": "Gets the status for a project deletion job.", - "operationId": "TextAnalysisAuthoring_GetProjectDeletionStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The project deletion job result.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectDeletionJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Project Deletion Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/global/languages": { - "get": { - "description": "Lists the supported languages.", - "operationId": "TextAnalysisAuthoring_GetSupportedLanguages", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of supported languages.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringSupportedLanguages" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Supported Languages": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/global/training-config-versions": { - "get": { - "description": "Lists the support training config version for a given project type.", - "operationId": "TextAnalysisAuthoring_ListTrainingConfigVersions", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/TextAnalysisAuthoringProjectKindQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all trained models.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingConfigVersions" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Supported Training Config Versions": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - } - }, - "definitions": { - "TextAnalysisAuthoringConfusionMatrix": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixRow" - }, - "x-ms-client-name": "ConfusionMatrix" - }, - "TextAnalysisAuthoringConfusionMatrixCell": { - "description": "Represents a cell in a confusion matrix.", - "required": [ - "normalizedValue", - "rawValue" - ], - "type": "object", - "properties": { - "normalizedValue": { - "format": "float", - "description": "Represents normalized value in percentages.", - "type": "number" - }, - "rawValue": { - "format": "float", - "description": "Represents raw value.", - "type": "number" - } - }, - "x-ms-client-name": "ConfusionMatrixCell" - }, - "TextAnalysisAuthoringConfusionMatrixRow": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixCell" - }, - "x-ms-client-name": "ConfusionMatrixRow" - }, - "TextAnalysisAuthoringCreateDeploymentOptions": { - "description": "Represents the options for creating or updating a project deployment.", - "required": [ - "trainedModelLabel" - ], - "type": "object", - "properties": { - "trainedModelLabel": { - "description": "Represents the trained model label.", - "type": "string" - } - }, - "x-ms-client-name": "CreateDeploymentOptions" - }, - "TextAnalysisAuthoringCreateProjectOptions": { - "description": "Represents the options used to create or update a project.", - "required": [ - "projectKind", - "storageInputContainerName", - "projectName", - "language" - ], - "type": "object", - "properties": { - "projectKind": { - "description": "The project kind.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" - }, - "storageInputContainerName": { - "description": "The storage container name.", - "type": "string" - }, - "settings": { - "description": "The project settings.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectSettings" - }, - "projectName": { - "description": "The new project name.", - "type": "string" - }, - "multilingual": { - "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" - }, - "description": { - "description": "The project description.", - "type": "string" - }, - "language": { - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "CreateProjectOptions" - }, - "TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult": { - "description": "Represents the document evaluation result for a custom entity recognition project.", - "required": [ - "customEntityRecognitionResult" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - ], - "properties": { - "customEntityRecognitionResult": { - "description": "Represents the evaluation prediction for entity recognition.", - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult" - } - }, - "x-ms-discriminator-value": "CustomEntityRecognition", - "x-ms-client-name": "CustomEntityRecognitionDocumentEvaluationResult" - }, - "TextAnalysisAuthoringCustomEntityRecognitionEvaluationSummary": { - "description": "Represents the evaluation summary for a custom entity recognition project.", - "required": [ - "customEntityRecognitionEvaluation" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - ], - "properties": { - "customEntityRecognitionEvaluation": { - "description": "Contains the data related to extraction evaluation.", - "$ref": "#/definitions/TextAnalysisAuthoringEntityRecognitionEvaluationSummary" - } - }, - "x-ms-discriminator-value": "CustomEntityRecognition", - "x-ms-client-name": "CustomEntityRecognitionEvaluationSummary" - }, - "TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult": { - "description": "Represents the document evaluation result for a custom multi-label classification project.", - "required": [ - "customMultiLabelClassificationResult" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - ], - "properties": { - "customMultiLabelClassificationResult": { - "description": "Represents the evaluation prediction for multi label classification.", - "$ref": "#/definitions/TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult" - } - }, - "x-ms-discriminator-value": "CustomMultiLabelClassification", - "x-ms-client-name": "CustomMultiLabelClassificationDocumentEvaluationResult" - }, - "TextAnalysisAuthoringCustomMultiLabelClassificationEvaluationSummary": { - "description": "Represents the evaluation summary for a custom multi-label classification project.", - "required": [ - "customMultiLabelClassificationEvaluation" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - ], - "properties": { - "customMultiLabelClassificationEvaluation": { - "description": "Contains the data related to multi label classification evaluation.", - "$ref": "#/definitions/TextAnalysisAuthoringMultiLabelClassificationEvaluationSummary" - } - }, - "x-ms-discriminator-value": "CustomMultiLabelClassification", - "x-ms-client-name": "CustomMultiLabelClassificationEvaluationSummary" - }, - "TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult": { - "description": "Represents the document evaluation result for a custom single-label classification project.", - "required": [ - "customSingleLabelClassificationResult" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - ], - "properties": { - "customSingleLabelClassificationResult": { - "description": "Represents the evaluation prediction for single label classification.", - "$ref": "#/definitions/TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult" - } - }, - "x-ms-discriminator-value": "CustomSingleLabelClassification", - "x-ms-client-name": "CustomSingleLabelClassificationDocumentEvaluationResult" - }, - "TextAnalysisAuthoringCustomSingleLabelClassificationEvaluationSummary": { - "description": "Represents the evaluation summary for a custom single-label classification project.", - "required": [ - "customSingleLabelClassificationEvaluation" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - ], - "properties": { - "customSingleLabelClassificationEvaluation": { - "description": "Contains the data related to single label classification evaluation.", - "$ref": "#/definitions/TextAnalysisAuthoringSingleLabelClassificationEvaluationSummary" - } - }, - "x-ms-discriminator-value": "CustomSingleLabelClassification", - "x-ms-client-name": "CustomSingleLabelClassificationEvaluationSummary" - }, - "TextAnalysisAuthoringDeploymentJobState": { - "description": "Represents the state of a deployment job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "DeploymentJobState" - }, - "TextAnalysisAuthoringDocumentEntityLabelEvaluationResult": { - "description": "Represents an evaluation result entity label.", - "required": [ - "category", - "offset", - "length" - ], - "type": "object", - "properties": { - "category": { - "description": "Represents the entity category.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "Represents the entity offset index relative to the original text.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "Represents the entity length.", - "type": "integer" - } - }, - "x-ms-client-name": "DocumentEntityLabelEvaluationResult" - }, - "TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult": { - "description": "Represents the entity recognition evaluation result for a document.", - "required": [ - "entities" - ], - "type": "object", - "properties": { - "entities": { - "description": "Represents the document labelled entities.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityRegionEvaluationResult" - } - } - }, - "x-ms-client-name": "DocumentEntityRecognitionEvaluationResult" - }, - "TextAnalysisAuthoringDocumentEntityRegionEvaluationResult": { - "description": "Represents the evaluation comparison between the expected and predicted entities of a document region.", - "required": [ - "expectedEntities", - "predictedEntities", - "regionOffset", - "regionLength" - ], - "type": "object", - "properties": { - "expectedEntities": { - "description": "Represents the region's expected entity labels.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityLabelEvaluationResult" - } - }, - "predictedEntities": { - "description": "Represents the region's predicted entity labels.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityLabelEvaluationResult" - } - }, - "regionOffset": { - "format": "int32", - "description": "Represents the region offset.", - "type": "integer" - }, - "regionLength": { - "format": "int32", - "description": "Represents the region length.", - "type": "integer" - } - }, - "x-ms-client-name": "DocumentEntityRegionEvaluationResult" - }, - "TextAnalysisAuthoringDocumentEvaluationResult": { - "description": "Represents the evaluation result of a document.", - "required": [ - "location", - "language", - "projectKind" - ], - "type": "object", - "properties": { - "location": { - "description": "Represents the document path.", - "type": "string" - }, - "language": { - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "projectKind": { - "description": "Represents the project kind.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" - } - }, - "discriminator": "projectKind", - "x-ms-client-name": "DocumentEvaluationResult" - }, - "TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult": { - "description": "Represents the comparison between the expected and predicted classes that are result from the evaluation operation.", - "required": [ - "expectedClasses", - "predictedClasses" - ], - "type": "object", - "properties": { - "expectedClasses": { - "description": "Represents the document's expected classes.", - "type": "array", - "items": { - "type": "string" - } - }, - "predictedClasses": { - "description": "Represents the document's predicted classes.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ms-client-name": "DocumentMultiLabelClassificationEvaluationResult" - }, - "TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult": { - "description": "Represents the comparison between the expected and predicted class that result from an evaluation operation.", - "required": [ - "expectedClass", - "predictedClass" - ], - "type": "object", - "properties": { - "expectedClass": { - "description": "Represents the document's expected class.", - "type": "string" - }, - "predictedClass": { - "description": "Represents the document's predicted class.", - "type": "string" - } - }, - "x-ms-client-name": "DocumentSingleLabelClassificationEvaluationResult" - }, - "TextAnalysisAuthoringEntityEvaluationSummary": { - "description": "Represents the evaluation summary for an entity.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], - "type": "object", - "properties": { - "f1": { - "format": "double", - "description": "Represents the model precision", - "type": "number" - }, - "precision": { - "format": "double", - "description": "Represents the model recall", - "type": "number" - }, - "recall": { - "format": "double", - "description": "Represents the model F1 score", - "type": "number" - }, - "truePositiveCount": { - "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" - }, - "trueNegativeCount": { - "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" - }, - "falsePositiveCount": { - "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" - }, - "falseNegativeCount": { - "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" - } - }, - "x-ms-client-name": "EntityEvaluationSummary" - }, - "TextAnalysisAuthoringEntityRecognitionEvaluationSummary": { - "description": "Represents the evaluation summary for a custom entity recognition project.", - "required": [ - "confusionMatrix", - "entities", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], - "type": "object", - "properties": { - "confusionMatrix": { - "description": "Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted.", - "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrix" - }, - "entities": { - "description": "Represents the entities evaluation", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringEntityEvaluationSummary" - } - }, - "microF1": { - "format": "float", - "description": "Represents the micro F1", - "type": "number" - }, - "microPrecision": { - "format": "float", - "description": "Represents the micro precision", - "type": "number" - }, - "microRecall": { - "format": "float", - "description": "Represents the micro recall", - "type": "number" - }, - "macroF1": { - "format": "float", - "description": "Represents the macro F1", - "type": "number" - }, - "macroPrecision": { - "format": "float", - "description": "Represents the macro precision", - "type": "number" - }, - "macroRecall": { - "format": "float", - "description": "Represents the macro recall", - "type": "number" - } - }, - "x-ms-client-name": "EntityRecognitionEvaluationSummary" - }, - "TextAnalysisAuthoringEvaluationKind": { - "enum": [ - "percentage", - "manual" - ], - "type": "string", - "x-ms-enum": { - "name": "EvaluationKind", - "modelAsString": true, - "values": [ - { - "value": "percentage", - "description": "Split the data into training and test sets according to user-defined percentages." - }, - { - "value": "manual", - "description": "Split the data according to the chosen dataset for every example in the data." - } - ] - }, - "x-ms-client-name": "EvaluationKind" - }, - "TextAnalysisAuthoringEvaluationOptions": { - "description": "Represents the options used running the evaluation.", - "type": "object", - "properties": { - "kind": { - "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationKind" - }, - "trainingSplitPercentage": { - "format": "int32", - "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" - }, - "testingSplitPercentage": { - "format": "int32", - "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" - } - }, - "x-ms-client-name": "EvaluationOptions" - }, - "TextAnalysisAuthoringEvaluationResults": { - "description": "Represents a list of results for an evaluation operation.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "THe list of documents evaluation results.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "EvaluationResults" - }, - "TextAnalysisAuthoringEvaluationSummary": { - "description": "Represents the summary for an evaluation operation.", - "required": [ - "projectKind", - "evaluationOptions" - ], - "type": "object", - "properties": { - "projectKind": { - "description": "Represents the project type that the evaluation ran on.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" - }, - "evaluationOptions": { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions" - } - }, - "discriminator": "projectKind", - "x-ms-client-name": "EvaluationSummary" - }, - "TextAnalysisAuthoringExportedClass": { - "description": "Represents a class of an exported project.", - "type": "object", - "properties": { - "category": { - "description": "The class category.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedClass" - }, - "TextAnalysisAuthoringExportedCustomEntityRecognitionDocument": { - "description": "Represents an exported document for a custom entity recognition project.", - "type": "object", - "properties": { - "entities": { - "description": "The list of entity labels belonging to the document.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentRegion" - } - }, - "location": { - "description": "The location of the document in the storage.", - "type": "string" - }, - "language": { - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedCustomEntityRecognitionDocument" - }, - "TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets": { - "description": "Represents the exported assets for a entity recognition project.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - ], - "properties": { - "entities": { - "description": "The list of entities belonging to the project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedEntity" - } - }, - "documents": { - "description": "The list of documents belonging to the project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomEntityRecognitionDocument" - } - } - }, - "x-ms-discriminator-value": "CustomEntityRecognition", - "x-ms-client-name": "ExportedCustomEntityRecognitionProjectAssets" - }, - "TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument": { - "description": "Represents an exported document of a custom multi-label classification project.", - "type": "object", - "properties": { - "classes": { - "description": "The document classes.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentClass" - } - }, - "location": { - "description": "The location of the document in the storage.", - "type": "string" - }, - "language": { - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedCustomMultiLabelClassificationDocument" - }, - "TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets": { - "description": "Represents the exported assets for a custom multi-label classification project.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - ], - "properties": { - "classes": { - "description": "The list of classes in the project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedClass" - } - }, - "documents": { - "description": "The list of documents in the project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument" - } - } - }, - "x-ms-discriminator-value": "CustomMultiLabelClassification", - "x-ms-client-name": "ExportedCustomMultiLabelClassificationProjectAssets" - }, - "TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument": { - "description": "Represents an exported document for a custom single-label classification project.", - "type": "object", - "properties": { - "class": { - "description": "The class of the documents.", - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentClass" - }, - "location": { - "description": "The location of the document in the storage.", - "type": "string" - }, - "language": { - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedCustomSingleLabelClassificationDocument" - }, - "TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets": { - "description": "Represents the exported assets for a single-label classification project.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - ], - "properties": { - "classes": { - "description": "The list of classes belonging to this project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedClass" - } - }, - "documents": { - "description": "The list of documents belonging to this project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument" - } - } - }, - "x-ms-discriminator-value": "CustomSingleLabelClassification", - "x-ms-client-name": "ExportedCustomSingleLabelClassificationProjectAssets" - }, - "TextAnalysisAuthoringExportedDocumentClass": { - "description": "Represents a classification label for a document.", - "type": "object", - "properties": { - "category": { - "type": "string" - } - }, - "x-ms-client-name": "ExportedDocumentClass" - }, - "TextAnalysisAuthoringExportedDocumentEntityLabel": { - "description": "Represents an entity label for a document.", - "type": "object", - "properties": { - "category": { - "description": "The entity category.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "Start position for the entity text.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "Length for the entity text.", - "type": "integer" - } - }, - "x-ms-client-name": "ExportedDocumentEntityLabel" - }, - "TextAnalysisAuthoringExportedDocumentRegion": { - "description": "Represents a region in a document for entity labeling.", - "type": "object", - "properties": { - "regionOffset": { - "format": "int32", - "description": "Start position for the region.", - "type": "integer" - }, - "regionLength": { - "format": "int32", - "description": "Length for the region text.", - "type": "integer" - }, - "labels": { - "description": "The list of entity labels belonging to this region.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentEntityLabel" - } - } - }, - "x-ms-client-name": "ExportedDocumentRegion" - }, - "TextAnalysisAuthoringExportedEntity": { - "description": "Represents an entity in an exported project.", - "type": "object", - "properties": { - "category": { - "description": "The entity category.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedEntity" - }, - "TextAnalysisAuthoringExportedProject": { - "description": "Represents an exported project.", - "required": [ - "projectFileVersion", - "stringIndexType", - "metadata" - ], - "type": "object", - "properties": { - "projectFileVersion": { - "description": "The version of the exported file.", - "type": "string" - }, - "stringIndexType": { - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "$ref": "#/definitions/TextAnalysisAuthoringStringIndexType" - }, - "metadata": { - "description": "Represents the project metadata.", - "$ref": "#/definitions/TextAnalysisAuthoringCreateProjectOptions" - }, - "assets": { - "description": "Represents the project assets.", - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - }, - "x-ms-client-name": "ExportedProject" - }, - "TextAnalysisAuthoringExportedProjectAssets": { - "description": "Represents the assets of an exported project.", - "required": [ - "projectKind" - ], - "type": "object", - "properties": { - "projectKind": { - "description": "The type of the project the assets belong to.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" - } - }, - "discriminator": "projectKind", - "x-ms-client-name": "ExportedProjectAssets" - }, - "TextAnalysisAuthoringExportProjectJobState": { - "description": "Represents the state of an export job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringJobState" - } - ], - "properties": { - "resultUrl": { - "description": "The URL to use in order to download the exported project.", - "type": "string" - } - }, - "x-ms-client-name": "ExportProjectJobState" - }, - "TextAnalysisAuthoringImportProjectJobState": { - "description": "Represents the state of an import job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "ImportProjectJobState" - }, - "TextAnalysisAuthoringJobState": { - "description": "Represents a job's state.", - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ], - "type": "object", - "properties": { - "jobId": { - "description": "The job ID.", - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "description": "The creation date time of the job.", - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "description": "The last date time the job was updated.", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "description": "The expiration date time of the job.", - "type": "string" - }, - "status": { - "description": "The job status.", - "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" - }, - "warnings": { - "description": "The warnings that were encountered while executing the job.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringWarning" - } - }, - "errors": { - "description": "The errors encountered while executing the job.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - } - }, - "x-ms-client-name": "JobState" - }, - "TextAnalysisAuthoringJobStatus": { - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling", - "partiallyCompleted" - ], - "type": "string", - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true - }, - "x-ms-client-name": "JobStatus" - }, - "TextAnalysisAuthoringMultiLabelClassEvaluationSummary": { - "description": "Represents the evaluation summary of a class in a multi-label classification project.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], - "type": "object", - "properties": { - "f1": { - "format": "double", - "description": "Represents the model precision", - "type": "number" - }, - "precision": { - "format": "double", - "description": "Represents the model recall", - "type": "number" - }, - "recall": { - "format": "double", - "description": "Represents the model F1 score", - "type": "number" - }, - "truePositiveCount": { - "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" - }, - "trueNegativeCount": { - "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" - }, - "falsePositiveCount": { - "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" - }, - "falseNegativeCount": { - "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" - } - }, - "x-ms-client-name": "MultiLabelClassEvaluationSummary" - }, - "TextAnalysisAuthoringMultiLabelClassificationEvaluationSummary": { - "description": "Represents the evaluation summary for a multi-label classification project.", - "required": [ - "classes", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], - "type": "object", - "properties": { - "classes": { - "description": "Represents the classes evaluation", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringMultiLabelClassEvaluationSummary" - } - }, - "microF1": { - "format": "float", - "description": "Represents the micro F1", - "type": "number" - }, - "microPrecision": { - "format": "float", - "description": "Represents the micro precision", - "type": "number" - }, - "microRecall": { - "format": "float", - "description": "Represents the micro recall", - "type": "number" - }, - "macroF1": { - "format": "float", - "description": "Represents the macro F1", - "type": "number" - }, - "macroPrecision": { - "format": "float", - "description": "Represents the macro precision", - "type": "number" - }, - "macroRecall": { - "format": "float", - "description": "Represents the macro recall", - "type": "number" - } - }, - "x-ms-client-name": "MultiLabelClassificationEvaluationSummary" - }, - "TextAnalysisAuthoringProjectDeletionJobState": { - "description": "Represents the state of a project deletion job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "ProjectDeletionJobState" - }, - "TextAnalysisAuthoringProjectDeployment": { - "description": "Represents a project deployment.", - "required": [ - "deploymentName", - "modelId", - "lastTrainedDateTime", - "lastDeployedDateTime", - "deploymentExpirationDate", - "modelTrainingConfigVersion" - ], - "type": "object", - "properties": { - "deploymentName": { - "description": "Represents deployment name.", - "type": "string" - }, - "modelId": { - "description": "Represents deployment modelId.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "Represents deployment last trained time.", - "type": "string" - }, - "lastDeployedDateTime": { - "format": "date-time", - "description": "Represents deployment last deployed time.", - "type": "string" - }, - "deploymentExpirationDate": { - "format": "date", - "description": "Represents deployment expiration date in the runtime.", - "type": "string" - }, - "modelTrainingConfigVersion": { - "description": "Represents model training config version.", - "type": "string" - } - }, - "x-ms-client-name": "ProjectDeployment" - }, - "TextAnalysisAuthoringProjectDeployments": { - "description": "Represents a list of retrieved deployments.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved deployments.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployment" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectDeployments" - }, - "TextAnalysisAuthoringProjectKind": { - "enum": [ - "CustomSingleLabelClassification", - "CustomMultiLabelClassification", - "CustomEntityRecognition" - ], - "type": "string", - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "value": "CustomSingleLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B." - }, - { - "value": "CustomMultiLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C." - }, - { - "value": "CustomEntityRecognition", - "description": "For building an extraction model to identify your domain categories using your own data." - } - ] - }, - "x-ms-client-name": "ProjectKind" - }, - "TextAnalysisAuthoringProjectMetadata": { - "description": "Represents the metadata of a project.", - "required": [ - "createdDateTime", - "lastModifiedDateTime", - "projectKind", - "storageInputContainerName", - "projectName", - "language" - ], - "type": "object", - "properties": { - "createdDateTime": { - "format": "date-time", - "description": "Represents the project creation datetime.", - "type": "string" - }, - "lastModifiedDateTime": { - "format": "date-time", - "description": "Represents the project last modification datetime.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "Represents the project last training datetime.", - "type": "string" - }, - "lastDeployedDateTime": { - "format": "date-time", - "description": "Represents the project last deployment datetime.", - "type": "string" - }, - "projectKind": { - "description": "The project kind.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" - }, - "storageInputContainerName": { - "description": "The storage container name.", - "type": "string" - }, - "settings": { - "description": "The project settings.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectSettings" - }, - "projectName": { - "description": "The new project name.", - "type": "string" - }, - "multilingual": { - "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" - }, - "description": { - "description": "The project description.", - "type": "string" - }, - "language": { - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "ProjectMetadata" - }, - "TextAnalysisAuthoringProjectSettings": { - "description": "Represents the settings used to define the project behavior.", - "type": "object", - "x-ms-client-name": "ProjectSettings" - }, - "TextAnalysisAuthoringProjectsMetadata": { - "description": "Represents a list of retrieved projects' metadata.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of projects.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectsMetadata" - }, - "TextAnalysisAuthoringProjectTrainedModel": { - "description": "Represents a trained model.", - "required": [ - "label", - "modelId", - "lastTrainedDateTime", - "lastTrainingDurationInSeconds", - "modelExpirationDate", - "modelTrainingConfigVersion" - ], - "type": "object", - "properties": { - "label": { - "description": "The trained model label.", - "type": "string" - }, - "modelId": { - "description": "The model ID.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "The last trained date time of the model.", - "type": "string" - }, - "lastTrainingDurationInSeconds": { - "format": "int32", - "description": "The duration of the model's last training request in seconds.", - "type": "integer" - }, - "modelExpirationDate": { - "format": "date", - "description": "The model expiration date.", - "type": "string" - }, - "modelTrainingConfigVersion": { - "description": "The model training config version.", - "type": "string" - } - }, - "x-ms-client-name": "ProjectTrainedModel" - }, - "TextAnalysisAuthoringProjectTrainedModels": { - "description": "Represents a list of retrieved trained models.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved jobs.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModel" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectTrainedModels" - }, - "TextAnalysisAuthoringSingleLabelClassEvaluationSummary": { - "description": "Represents the evaluation summary for a class in a single-label classification project.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], - "type": "object", - "properties": { - "f1": { - "format": "double", - "description": "Represents the model precision", - "type": "number" - }, - "precision": { - "format": "double", - "description": "Represents the model recall", - "type": "number" - }, - "recall": { - "format": "double", - "description": "Represents the model F1 score", - "type": "number" - }, - "truePositiveCount": { - "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" - }, - "trueNegativeCount": { - "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" - }, - "falsePositiveCount": { - "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" - }, - "falseNegativeCount": { - "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" - } - }, - "x-ms-client-name": "SingleLabelClassEvaluationSummary" - }, - "TextAnalysisAuthoringSingleLabelClassificationEvaluationSummary": { - "description": "Represents the evaluation summary for a custom single-label classification project.", - "required": [ - "confusionMatrix", - "classes", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], - "type": "object", - "properties": { - "confusionMatrix": { - "description": "Represents the confusion matrix between two classes (the two classes can be the same). The matrix is between the class that was labelled and the class that was predicted.", - "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrix" - }, - "classes": { - "description": "Represents the classes evaluation", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringSingleLabelClassEvaluationSummary" - } - }, - "microF1": { - "format": "float", - "description": "Represents the micro F1", - "type": "number" - }, - "microPrecision": { - "format": "float", - "description": "Represents the micro precision", - "type": "number" - }, - "microRecall": { - "format": "float", - "description": "Represents the micro recall", - "type": "number" - }, - "macroF1": { - "format": "float", - "description": "Represents the macro F1", - "type": "number" - }, - "macroPrecision": { - "format": "float", - "description": "Represents the macro precision", - "type": "number" - }, - "macroRecall": { - "format": "float", - "description": "Represents the macro recall", - "type": "number" - } - }, - "x-ms-client-name": "SingleLabelClassificationEvaluationSummary" - }, - "TextAnalysisAuthoringStringIndexType": { - "enum": [ - "Utf16CodeUnit" - ], - "type": "string", - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - }, - "x-ms-client-name": "StringIndexType" - }, - "TextAnalysisAuthoringSubTrainingJobState": { - "description": "Represents the detailed state of a training sub-operation.", - "required": [ - "percentComplete", - "status" - ], - "type": "object", - "properties": { - "percentComplete": { - "format": "int32", - "description": "Represents progress percentage.", - "type": "integer" - }, - "startDateTime": { - "format": "date-time", - "description": "Represents the start date time.", - "type": "string" - }, - "endDateTime": { - "format": "date-time", - "description": "Represents the end date time.", - "type": "string" - }, - "status": { - "description": "Represents the status of the sub-operation.", - "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" - } - }, - "x-ms-client-name": "SubTrainingJobState" - }, - "TextAnalysisAuthoringSupportedLanguage": { - "description": "Represents a supported language.", - "required": [ - "languageName", - "languageCode" - ], - "type": "object", - "properties": { - "languageName": { - "description": "The language name.", - "type": "string" - }, - "languageCode": { - "description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "SupportedLanguage" - }, - "TextAnalysisAuthoringSupportedLanguages": { - "description": "Represents a list of retrieved languages.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of the languages.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringSupportedLanguage" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "SupportedLanguages" - }, - "TextAnalysisAuthoringSwapDeploymentsOptions": { - "description": "Represents the options for swapping two deployments together.", - "required": [ - "firstDeploymentName", - "secondDeploymentName" - ], - "type": "object", - "properties": { - "firstDeploymentName": { - "description": "Represents the first deployment name.", - "type": "string" - }, - "secondDeploymentName": { - "description": "Represents the second deployment name.", - "type": "string" - } - }, - "x-ms-client-name": "SwapDeploymentsOptions" - }, - "TextAnalysisAuthoringTrainingConfigVersion": { - "description": "Represents a training config version.", - "required": [ - "trainingConfigVersion", - "modelExpirationDate" - ], - "type": "object", - "properties": { - "trainingConfigVersion": { - "description": "Represents the version of the config.", - "type": "string" - }, - "modelExpirationDate": { - "format": "date", - "description": "Represents the training config version expiration date.", - "type": "string" - } - }, - "x-ms-client-name": "TrainingConfigVersion" - }, - "TextAnalysisAuthoringTrainingConfigVersions": { - "description": "Represents a list of training config versions.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of the training config versions.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingConfigVersion" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "TrainingConfigVersions" - }, - "TextAnalysisAuthoringTrainingJobOptions": { - "description": "Represents the options for starting a new training job.", - "required": [ - "modelLabel", - "trainingConfigVersion" - ], - "type": "object", - "properties": { - "modelLabel": { - "description": "Represents the output model label.", - "type": "string" - }, - "trainingConfigVersion": { - "description": "Represents training config version.", - "type": "string" - }, - "evaluationOptions": { - "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20.", - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions" - } - }, - "x-ms-client-name": "TrainingJobOptions" - }, - "TextAnalysisAuthoringTrainingJobResult": { - "description": "Represents the output of a training job.", - "required": [ - "modelLabel", - "trainingConfigVersion", - "trainingStatus" - ], - "type": "object", - "properties": { - "modelLabel": { - "description": "Represents trained model label.", - "type": "string" - }, - "trainingConfigVersion": { - "description": "Represents training config version.", - "type": "string" - }, - "trainingStatus": { - "description": "Represents model train status.", - "$ref": "#/definitions/TextAnalysisAuthoringSubTrainingJobState" - }, - "evaluationStatus": { - "description": "Represents model evaluation status.", - "$ref": "#/definitions/TextAnalysisAuthoringSubTrainingJobState" - }, - "estimatedEndDateTime": { - "format": "date-time", - "description": "Represents the estimate end date time for training and evaluation.", - "type": "string" - } - }, - "x-ms-client-name": "TrainingJobResult" - }, - "TextAnalysisAuthoringTrainingJobs": { - "description": "Represents a list of retrieved training jobs.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of jobs.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobState" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "TrainingJobs" - }, - "TextAnalysisAuthoringTrainingJobState": { - "description": "Represents the state of a training job.", - "required": [ - "result" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringJobState" - } - ], - "properties": { - "result": { - "description": "Represents training tasks detailed result.", - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobResult" - } - }, - "x-ms-client-name": "TrainingJobState" - }, - "TextAnalysisAuthoringWarning": { - "description": "Represents a warning that was encountered while executing the request.", - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "description": "The warning code.", - "type": "string" - }, - "message": { - "description": "The warning message.", - "type": "string" - } - }, - "x-ms-client-name": "Warning" - } - }, - "parameters": { - "TextAnalysisAuthoringStringIndexTypeQueryParameter": { - "in": "query", - "name": "stringIndexType", - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "required": true, - "type": "string", - "enum": [ - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "TextAnalysisAuthoringJobIdPathParameter": { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "TextAnalysisAuthoringTrainedModelLabelPathParameter": { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model label.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "TextAnalysisAuthoringProjectKindQueryParameter": { - "in": "query", - "name": "projectKind", - "description": "The project kind.", - "required": true, - "type": "string", - "enum": [ - "CustomSingleLabelClassification", - "CustomMultiLabelClassification", - "CustomEntityRecognition" - ], - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "value": "CustomSingleLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B." - }, - { - "value": "CustomMultiLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C." - }, - { - "value": "CustomEntityRecognition", - "description": "For building an extraction model to identify your domain categories using your own data." - } - ] - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/analyzetext.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/analyzetext.json deleted file mode 100644 index f5aba6cbf9c3..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/analyzetext.json +++ /dev/null @@ -1,2737 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Text Analysis", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/azure/cognitive-services/language-service/overview.0", - "version": "2022-07-01-preview" - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/:analyze-text": { - "post": { - "summary": "Request text analysis over a collection of documents.", - "description": "Submit a collection of text documents for analysis. Specify a single unique task to be executed immediately.", - "operationId": "AnalyzeText", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/ShowStats" - }, - { - "description": "Collection of documents to analyze and a single task to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeTextTask" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "A successful call result", - "schema": { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Entity Linking Request": { - "$ref": "./examples/text/SuccessfulEntityLinkingRequest.json" - }, - "Successful Entity Recognition Request": { - "$ref": "./examples/text/SuccessfulEntityRecognitionRequest.json" - }, - "Successful Key Phrase Extraction Request": { - "$ref": "./examples/text/SuccessfulKeyPhraseExtractionRequest.json" - }, - "Successful PII Entity Recognition Request": { - "$ref": "./examples/text/SuccessfulPiiEntityRecognitionRequest.json" - }, - "Successful Language Detection Request": { - "$ref": "./examples/text/SuccessfulLanguageDetectionRequest.json" - }, - "Successful Sentiment Analysis Request": { - "$ref": "./examples/text/SuccessfulSentimentAnalysisRequest.json" - } - } - } - }, - "/analyze-text/jobs": { - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "description": "Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.", - "operationId": "AnalyzeText_SubmitJob", - "summary": "Submit text analysis job", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Collection of documents to analyze and one or more tasks to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeTextJobsInput" - }, - "required": true - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Submit Analysis Job Request": { - "$ref": "./examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json" - }, - "Successful Healthcare Post Request": { - "$ref": "./examples/text/SuccessfulHealthcarePostRequest.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/analyze-text/jobs/{jobId}": { - "get": { - "produces": [ - "application/json" - ], - "description": "Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are succeeded, the job will transition to the succeeded state and results will be available for each task.", - "operationId": "AnalyzeText_JobStatus", - "summary": "Get analysis status and results", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/JobId" - }, - { - "$ref": "common.json#/parameters/ShowStats" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - } - ], - "responses": { - "200": { - "description": "Analysis job status and metadata.", - "schema": { - "$ref": "#/definitions/AnalyzeTextJobState" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Text Analysis Job Status Request": { - "$ref": "./examples/text/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json" - }, - "Successful Get Text Analysis Health Request": { - "$ref": "./examples/text/SuccessfulHealthcareTaskStatusRequest.json" - } - } - } - }, - "/analyze-text/jobs/{jobId}:cancel": { - "post": { - "produces": [ - "application/json" - ], - "description": "Cancel a long-running Text Analysis job.", - "operationId": "AnalyzeText_CancelJob", - "summary": "Cancel a long-running Text Analysis job", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/JobId" - } - ], - "responses": { - "202": { - "description": "Cancel Job request has been received.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Job Delete Request": { - "$ref": "./examples/text/SuccessfulAnalyzeTextJobsCancelRequest.json" - } - }, - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "AnalyzeTextTaskKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis tasks.", - "enum": [ - "SentimentAnalysis", - "EntityRecognition", - "PiiEntityRecognition", - "KeyPhraseExtraction", - "LanguageDetection", - "EntityLinking" - ], - "x-ms-enum": { - "name": "AnalyzeTextTaskKind", - "modelAsString": true - } - }, - "AnalyzeTextLROTaskKind": { - "type": "string", - "description": "Enumeration of supported long-running Text Analysis tasks.", - "enum": [ - "SentimentAnalysis", - "EntityRecognition", - "PiiEntityRecognition", - "KeyPhraseExtraction", - "EntityLinking", - "Healthcare", - "ExtractiveSummarization", - "CustomEntityRecognition", - "CustomSingleLabelClassification", - "CustomMultiLabelClassification" - ], - "x-ms-enum": { - "name": "AnalyzeTextLROTaskKind", - "modelAsString": true - } - }, - "AnalyzeTextTaskResultsKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis task results.", - "enum": [ - "SentimentAnalysisResults", - "EntityRecognitionResults", - "PiiEntityRecognitionResults", - "KeyPhraseExtractionResults", - "LanguageDetectionResults", - "EntityLinkingResults" - ], - "x-ms-enum": { - "name": "AnalyzeTextTaskResultsKind", - "modelAsString": true - } - }, - "AnalyzeTextLROResultsKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis long-running operation task results.", - "enum": [ - "SentimentAnalysisLROResults", - "EntityRecognitionLROResults", - "PiiEntityRecognitionLROResults", - "KeyPhraseExtractionLROResults", - "EntityLinkingLROResults", - "HealthcareLROResults", - "ExtractiveSummarizationLROResults", - "CustomEntityRecognitionLROResults", - "CustomSingleLabelClassificationLROResults", - "CustomMultiLabelClassificationLROResults" - ], - "x-ms-enum": { - "name": "AnalyzeTextLROResultsKind", - "modelAsString": true - } - }, - "MultiLanguageAnalysisInput": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/definitions/MultiLanguageInput" - } - } - } - }, - "LanguageDetectionAnalysisInput": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/definitions/LanguageInput" - } - } - } - }, - "AnalyzeTextTask": { - "type": "object", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextTaskKind" - } - } - }, - "AnalyzeTextLROTask": { - "type": "object", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextLROTaskKind" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskIdentifier" - } - ] - }, - "AnalyzeTextTaskResult": { - "type": "object", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextTaskResultsKind" - } - } - }, - "AnalyzeTextEntityLinkingInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/EntityLinkingTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "EntityLinking" - }, - "AnalyzeTextEntityRecognitionInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/EntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "EntityRecognition" - }, - "AnalyzeTextKeyPhraseExtractionInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/KeyPhraseTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "KeyPhraseExtraction" - }, - "AnalyzeTextPiiEntitiesRecognitionInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/PiiTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "PiiEntityRecognition" - }, - "AnalyzeTextLanguageDetectionInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/LanguageDetectionAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/LanguageDetectionTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "LanguageDetection" - }, - "AnalyzeTextSentimentAnalysisInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/SentimentAnalysisTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "SentimentAnalysis" - }, - "AnalyzeTextJobsInput": { - "type": "object", - "properties": { - "displayName": { - "description": "Optional display name for the analysis job.", - "type": "string" - }, - "defaultLanguage": { - "description": "Default language to use for records requesting automatic language detection.", - "type": "string" - }, - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "tasks": { - "description": "The set of tasks to execute on the input documents.", - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - } - }, - "required": [ - "analysisInput", - "tasks" - ] - }, - "CustomTaskParameters": { - "type": "object", - "description": "Parameters object for a text analysis task using custom models.", - "properties": { - "projectName": { - "description": "This field indicates the project name for the model.", - "type": "string" - }, - "deploymentName": { - "description": "This field indicates the deployment name for the model.", - "type": "string" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskParameters" - } - ], - "required": [ - "projectName", - "deploymentName" - ] - }, - "CustomResult": { - "type": "object", - "properties": { - "errors": { - "type": "array", - "description": "Errors by document id.", - "items": { - "$ref": "#/definitions/DocumentError" - } - }, - "statistics": { - "$ref": "common.json#/definitions/RequestStatistics" - }, - "projectName": { - "type": "string", - "description": "This field indicates the project name for the model." - }, - "deploymentName": { - "type": "string", - "description": "This field indicates the deployment name for the model." - } - }, - "required": [ - "errors", - "projectName", - "deploymentName" - ] - }, - "CustomEntitiesTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Entities task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/CustomTaskParameters" - } - ] - }, - "CustomEntitiesLROTask": { - "type": "object", - "description": "Use custom models to ease the process of information extraction from unstructured documents like contracts or financial documents", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomEntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomEntityRecognition" - }, - "CustomEntitiesResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/EntitiesDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/CustomResult" - } - ], - "required": [ - "documents" - ] - }, - "CustomSingleLabelClassificationTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Single Classification task.", - "allOf": [ - { - "$ref": "#/definitions/CustomTaskParameters" - } - ] - }, - "CustomSingleLabelClassificationLROTask": { - "type": "object", - "description": "Use custom models to classify text into single label taxonomy", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomSingleLabelClassificationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomSingleLabelClassification" - }, - "CustomLabelClassificationResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/ClassificationDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/CustomResult" - } - ], - "required": [ - "documents" - ] - }, - "ClassificationResult": { - "type": "object", - "required": [ - "category", - "confidenceScore" - ], - "properties": { - "category": { - "type": "string", - "description": "Classification type." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the recognized class." - } - } - }, - "CustomMultiLabelClassificationTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Multi Classification task.", - "allOf": [ - { - "$ref": "#/definitions/CustomTaskParameters" - } - ] - }, - "CustomMultiLabelClassificationLROTask": { - "type": "object", - "description": "Use custom models to classify text into multi label taxonomy", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomMultiLabelClassificationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomMultiLabelClassification" - }, - "ClassificationDocumentResult": { - "type": "object", - "properties": { - "class": { - "type": "array", - "items": { - "$ref": "#/definitions/ClassificationResult" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "class" - ] - }, - "HealthcareTaskParameters": { - "type": "object", - "description": "Supported parameters for a Healthcare task.", - "properties": { - "fhirVersion": { - "type": "string", - "description": "The FHIR Spec version that the result will use to format the fhirBundle. For additional information see https://www.hl7.org/fhir/overview.html.", - "enum": [ - "4.0.1" - ], - "x-ms-enum": { - "name": "fhirVersion", - "modelAsString": true - } - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "HealthcareLROTask": { - "type": "object", - "properties": { - "parameters": { - "$ref": "#/definitions/HealthcareTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "Healthcare" - }, - "HealthcareResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "#/definitions/HealthcareEntitiesDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "HealthcareEntitiesDocumentResult": { - "type": "object", - "properties": { - "entities": { - "description": "Healthcare entities.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareEntity" - } - }, - "relations": { - "type": "array", - "description": "Healthcare entity relations.", - "items": { - "$ref": "#/definitions/HealthcareRelation" - } - }, - "fhirBundle": { - "type": "object", - "description": "JSON bundle containing a FHIR compatible object for consumption in other Healthcare tools. For additional information see https://www.hl7.org/fhir/overview.html.", - "additionalProperties": {} - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "entities", - "relations" - ] - }, - "HealthcareEntity": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "x-ms-enum": { - "name": "healthcareEntityCategory", - "modelAsString": true - }, - "type": "string", - "description": "Healthcare Entity Category.", - "enum": [ - "BodyStructure", - "Age", - "Gender", - "ExaminationName", - "Date", - "Direction", - "Frequency", - "MeasurementValue", - "MeasurementUnit", - "RelationalOperator", - "Time", - "GeneOrProtein", - "Variant", - "AdministrativeEvent", - "CareEnvironment", - "HealthcareProfession", - "Diagnosis", - "SymptomOrSign", - "ConditionalQualifier", - "MedicationClass", - "MedicationName", - "Dosage", - "MedicationForm", - "MedicationRoute", - "FamilyRelation", - "TreatmentName" - ] - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub type." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted entity." - }, - "assertion": { - "type": "object", - "$ref": "#/definitions/HealthcareAssertion" - }, - "name": { - "description": "Preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'.", - "type": "string" - }, - "links": { - "description": "Entity references in known data sources.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareEntityLink" - } - } - }, - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ] - }, - "HealthcareRelation": { - "type": "object", - "description": "Every relation is an entity graph of a certain relationType, where all entities are connected and have specific roles within the relation context.", - "required": [ - "relationType", - "entities" - ], - "properties": { - "relationType": { - "description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc.", - "type": "string", - "enum": [ - "Abbreviation", - "DirectionOfBodyStructure", - "DirectionOfCondition", - "DirectionOfExamination", - "DirectionOfTreatment", - "DosageOfMedication", - "FormOfMedication", - "FrequencyOfMedication", - "FrequencyOfTreatment", - "QualifierOfCondition", - "RelationOfExamination", - "RouteOfMedication", - "TimeOfCondition", - "TimeOfEvent", - "TimeOfExamination", - "TimeOfMedication", - "TimeOfTreatment", - "UnitOfCondition", - "UnitOfExamination", - "ValueOfCondition", - "ValueOfExamination" - ], - "x-ms-enum": { - "name": "relationType", - "modelAsString": true - } - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted relation." - }, - "entities": { - "description": "The entities in the relation.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareRelationEntity" - } - } - } - }, - "HealthcareAssertion": { - "type": "object", - "properties": { - "conditionality": { - "description": "Describes any conditionality on the entity.", - "type": "string", - "enum": [ - "hypothetical", - "conditional" - ], - "x-ms-enum": { - "name": "Conditionality", - "modelAsString": false - } - }, - "certainty": { - "description": "Describes the entities certainty and polarity.", - "type": "string", - "enum": [ - "positive", - "positivePossible", - "neutralPossible", - "negativePossible", - "negative" - ], - "x-ms-enum": { - "name": "Certainty", - "modelAsString": false - } - }, - "association": { - "description": "Describes if the entity is the subject of the text or if it describes someone else.", - "type": "string", - "enum": [ - "subject", - "other" - ], - "x-ms-enum": { - "name": "Association", - "modelAsString": false - } - } - } - }, - "HealthcareRelationEntity": { - "type": "object", - "required": [ - "ref", - "role" - ], - "properties": { - "ref": { - "description": "Reference link object, using a JSON pointer RFC 6901 (URI Fragment Identifier Representation), pointing to the entity .", - "type": "string" - }, - "role": { - "description": "Role of entity in the relationship. For example: 'CD20-positive diffuse large B-cell lymphoma' has the following entities with their roles in parenthesis: CD20 (GeneOrProtein), Positive (Expression), diffuse large B-cell lymphoma (Diagnosis).", - "type": "string" - } - } - }, - "HealthcareEntityLink": { - "type": "object", - "required": [ - "dataSource", - "id" - ], - "properties": { - "dataSource": { - "description": "Entity Catalog. Examples include: UMLS, CHV, MSH, etc.", - "type": "string" - }, - "id": { - "description": "Entity id in the given source catalog.", - "type": "string" - } - } - }, - "SentimentAnalysisTaskParameters": { - "type": "object", - "description": "Supported parameters for a Sentiment Analysis task.", - "properties": { - "opinionMining": { - "type": "boolean", - "default": false - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "SentimentAnalysisLROTask": { - "type": "object", - "description": "An object representing the task definition for a Sentiment Analysis task.", - "properties": { - "parameters": { - "$ref": "#/definitions/SentimentAnalysisTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "SentimentAnalysis" - }, - "SentimentTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/SentimentResponse" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "SentimentAnalysisResults" - }, - "SentimentResponse": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Sentiment analysis per document.", - "items": { - "allOf": [ - { - "$ref": "#/definitions/SentimentDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "SentimentDocumentResult": { - "type": "object", - "properties": { - "sentiment": { - "type": "string", - "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).", - "enum": [ - "positive", - "neutral", - "negative", - "mixed" - ], - "x-ms-enum": { - "name": "DocumentSentimentValue", - "modelAsString": false - } - }, - "confidenceScores": { - "description": "Document level sentiment confidence scores between 0 and 1 for each sentiment class.", - "$ref": "#/definitions/SentimentConfidenceScorePerLabel" - }, - "sentences": { - "type": "array", - "description": "Sentence level sentiment analysis.", - "items": { - "$ref": "#/definitions/SentenceSentiment" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "sentiment", - "confidenceScores", - "sentences" - ] - }, - "SentimentConfidenceScorePerLabel": { - "type": "object", - "required": [ - "positive", - "neutral", - "negative" - ], - "properties": { - "positive": { - "description": "Confidence score for positive sentiment", - "type": "number", - "format": "double" - }, - "neutral": { - "description": "Confidence score for neutral sentiment", - "type": "number", - "format": "double" - }, - "negative": { - "description": "Confidence score for negative sentiment", - "type": "number", - "format": "double" - } - }, - "description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative." - }, - "SentenceSentiment": { - "type": "object", - "required": [ - "text", - "sentiment", - "confidenceScores", - "offset", - "length" - ], - "properties": { - "text": { - "type": "string", - "description": "The sentence text." - }, - "sentiment": { - "type": "string", - "description": "The predicted Sentiment for the sentence.", - "enum": [ - "positive", - "neutral", - "negative" - ], - "x-ms-enum": { - "name": "SentenceSentimentValue", - "modelAsString": false - } - }, - "confidenceScores": { - "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes.", - "$ref": "#/definitions/SentimentConfidenceScorePerLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The sentence offset from the start of the document." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the sentence." - }, - "targets": { - "type": "array", - "description": "The array of sentence targets for the sentence.", - "items": { - "$ref": "#/definitions/SentenceTarget" - } - }, - "assessments": { - "type": "array", - "description": "The array of assessments for the sentence.", - "items": { - "$ref": "#/definitions/SentenceAssessment" - } - } - } - }, - "SentenceTarget": { - "type": "object", - "required": [ - "confidenceScores", - "length", - "offset", - "relations", - "sentiment", - "text" - ], - "properties": { - "sentiment": { - "type": "string", - "enum": [ - "positive", - "mixed", - "negative" - ], - "x-ms-enum": { - "name": "TokenSentimentValue", - "modelAsString": false - }, - "description": "Targeted sentiment in the sentence." - }, - "confidenceScores": { - "description": "Target sentiment confidence scores for the target in the sentence.", - "$ref": "#/definitions/TargetConfidenceScoreLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The target offset from the start of the sentence." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the target." - }, - "text": { - "type": "string", - "description": "The target text detected." - }, - "relations": { - "type": "array", - "description": "The array of either assessment or target objects which is related to the target.", - "items": { - "$ref": "#/definitions/TargetRelation" - } - } - } - }, - "SentenceAssessment": { - "type": "object", - "required": [ - "confidenceScores", - "isNegated", - "length", - "offset", - "sentiment", - "text" - ], - "properties": { - "sentiment": { - "type": "string", - "enum": [ - "positive", - "mixed", - "negative" - ], - "x-ms-enum": { - "name": "TokenSentimentValue", - "modelAsString": false - }, - "description": "Assessment sentiment in the sentence." - }, - "confidenceScores": { - "description": "Assessment sentiment confidence scores in the sentence.", - "$ref": "#/definitions/TargetConfidenceScoreLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The assessment offset from the start of the sentence." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the assessment." - }, - "text": { - "type": "string", - "description": "The assessment text detected." - }, - "isNegated": { - "type": "boolean", - "description": "The indicator representing if the assessment is negated." - } - } - }, - "TargetRelation": { - "type": "object", - "required": [ - "ref", - "relationType" - ], - "properties": { - "relationType": { - "type": "string", - "enum": [ - "assessment", - "target" - ], - "x-ms-enum": { - "name": "TargetRelationType", - "modelAsString": false - }, - "description": "The type related to the target." - }, - "ref": { - "type": "string", - "description": "The JSON pointer indicating the linked object." - } - } - }, - "TargetConfidenceScoreLabel": { - "type": "object", - "required": [ - "negative", - "positive" - ], - "properties": { - "positive": { - "description": "Confidence score for positive sentiment", - "type": "number", - "format": "double" - }, - "negative": { - "description": "Confidence score for negative sentiment", - "type": "number", - "format": "double" - } - }, - "description": "Represents the confidence scores across all sentiment classes: positive, neutral, negative." - }, - "EntitiesTaskParameters": { - "type": "object", - "description": "Supported parameters for an Entity Recognition task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "EntitiesLROTask": { - "type": "object", - "description": "An object representing the task definition for an Entities Recognition task.", - "properties": { - "parameters": { - "$ref": "#/definitions/EntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "EntityRecognition" - }, - "EntitiesTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityRecognitionResults" - }, - "EntitiesResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/EntitiesDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "EntitiesDocumentResult": { - "type": "object", - "properties": { - "entities": { - "type": "array", - "description": "Recognized entities in the document.", - "items": { - "$ref": "#/definitions/Entity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "entities" - ] - }, - "Entity": { - "type": "object", - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ], - "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "type": "string", - "description": "Entity type." - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub type." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted entity." - } - } - }, - "EntityLinkingTaskParameters": { - "type": "object", - "description": "Supported parameters for an Entity Linking task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "EntityLinkingLROTask": { - "type": "object", - "description": "An object representing the task definition for an Entity Linking task.", - "properties": { - "parameters": { - "$ref": "#/definitions/EntityLinkingTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "EntityLinking" - }, - "EntityLinkingTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntityLinkingResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityLinkingResults" - }, - "EntityLinkingResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/LinkedEntitiesDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "LinkedEntitiesDocumentResult": { - "type": "object", - "required": [ - "entities" - ], - "properties": { - "entities": { - "type": "array", - "description": "Recognized well known entities in the document.", - "items": { - "$ref": "#/definitions/LinkedEntity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ] - }, - "LinkedEntity": { - "type": "object", - "required": [ - "name", - "matches", - "language", - "url", - "dataSource" - ], - "properties": { - "name": { - "type": "string", - "description": "Entity Linking formal name." - }, - "matches": { - "type": "array", - "description": "List of instances this entity appears in the text.", - "items": { - "$ref": "#/definitions/Match" - } - }, - "language": { - "type": "string", - "description": "Language used in the data source." - }, - "id": { - "type": "string", - "description": "Unique identifier of the recognized entity from the data source." - }, - "url": { - "type": "string", - "description": "URL for the entity's page from the data source." - }, - "dataSource": { - "type": "string", - "description": "Data source used to extract entity linking, such as Wiki/Bing etc." - }, - "bingId": { - "type": "string", - "description": "Bing Entity Search API unique identifier of the recognized entity." - } - } - }, - "Match": { - "type": "object", - "required": [ - "confidenceScore", - "text", - "offset", - "length" - ], - "properties": { - "confidenceScore": { - "type": "number", - "format": "double", - "description": "If a well known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned." - }, - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity match text." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity match text." - } - } - }, - "PiiTaskParameters": { - "type": "object", - "description": "Supported parameters for a PII Entities Recognition task.", - "properties": { - "domain": { - "$ref": "#/definitions/PiiDomain" - }, - "piiCategories": { - "$ref": "#/definitions/PiiCategories" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "PiiLROTask": { - "type": "object", - "description": "An object representing the task definition for a PII Entities Recognition task.", - "properties": { - "parameters": { - "$ref": "#/definitions/PiiTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "PiiEntityRecognition" - }, - "PiiTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/PiiResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "PiiEntityRecognitionResults" - }, - "PiiResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/PiiEntitiesDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "PiiDomain": { - "type": "string", - "description": "The PII domain used for PII Entity Recognition.", - "default": "none", - "enum": [ - "phi", - "none" - ], - "x-ms-enum": { - "name": "PiiDomain", - "modelAsString": true, - "values": [ - { - "name": "phi", - "description": "Indicates that entities in the Personal Health Information domain should be redacted.", - "value": "phi" - }, - { - "name": "none", - "description": "Indicates that no domain is specified.", - "value": "none" - } - ] - } - }, - "PiiEntitiesDocumentResult": { - "type": "object", - "properties": { - "redactedText": { - "type": "string", - "description": "Returns redacted text." - }, - "entities": { - "type": "array", - "description": "Recognized entities in the document.", - "items": { - "$ref": "#/definitions/Entity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "redactedText", - "entities" - ] - }, - "PiiCategories": { - "description": "(Optional) describes the PII categories to return", - "items": { - "type": "string", - "x-ms-enum": { - "name": "PiiCategory", - "modelAsString": true - }, - "enum": [ - "ABARoutingNumber", - "ARNationalIdentityNumber", - "AUBankAccountNumber", - "AUDriversLicenseNumber", - "AUMedicalAccountNumber", - "AUPassportNumber", - "AUTaxFileNumber", - "AUBusinessNumber", - "AUCompanyNumber", - "ATIdentityCard", - "ATTaxIdentificationNumber", - "ATValueAddedTaxNumber", - "AzureDocumentDBAuthKey", - "AzureIAASDatabaseConnectionAndSQLString", - "AzureIoTConnectionString", - "AzurePublishSettingPassword", - "AzureRedisCacheString", - "AzureSAS", - "AzureServiceBusString", - "AzureStorageAccountKey", - "AzureStorageAccountGeneric", - "BENationalNumber", - "BENationalNumberV2", - "BEValueAddedTaxNumber", - "BRCPFNumber", - "BRLegalEntityNumber", - "BRNationalIDRG", - "BGUniformCivilNumber", - "CABankAccountNumber", - "CADriversLicenseNumber", - "CAHealthServiceNumber", - "CAPassportNumber", - "CAPersonalHealthIdentification", - "CASocialInsuranceNumber", - "CLIdentityCardNumber", - "CNResidentIdentityCardNumber", - "CreditCardNumber", - "HRIdentityCardNumber", - "HRNationalIDNumber", - "HRPersonalIdentificationNumber", - "HRPersonalIdentificationOIBNumberV2", - "CYIdentityCard", - "CYTaxIdentificationNumber", - "CZPersonalIdentityNumber", - "CZPersonalIdentityV2", - "DKPersonalIdentificationNumber", - "DKPersonalIdentificationV2", - "DrugEnforcementAgencyNumber", - "EEPersonalIdentificationCode", - "EUDebitCardNumber", - "EUDriversLicenseNumber", - "EUGPSCoordinates", - "EUNationalIdentificationNumber", - "EUPassportNumber", - "EUSocialSecurityNumber", - "EUTaxIdentificationNumber", - "FIEuropeanHealthNumber", - "FINationalID", - "FINationalIDV2", - "FIPassportNumber", - "FRDriversLicenseNumber", - "FRHealthInsuranceNumber", - "FRNationalID", - "FRPassportNumber", - "FRSocialSecurityNumber", - "FRTaxIdentificationNumber", - "FRValueAddedTaxNumber", - "DEDriversLicenseNumber", - "DEPassportNumber", - "DEIdentityCardNumber", - "DETaxIdentificationNumber", - "DEValueAddedNumber", - "GRNationalIDCard", - "GRNationalIDV2", - "GRTaxIdentificationNumber", - "HKIdentityCardNumber", - "HUValueAddedNumber", - "HUPersonalIdentificationNumber", - "HUTaxIdentificationNumber", - "INPermanentAccount", - "INUniqueIdentificationNumber", - "IDIdentityCardNumber", - "InternationalBankingAccountNumber", - "IEPersonalPublicServiceNumber", - "IEPersonalPublicServiceNumberV2", - "ILBankAccountNumber", - "ILNationalID", - "ITDriversLicenseNumber", - "ITFiscalCode", - "ITValueAddedTaxNumber", - "JPBankAccountNumber", - "JPDriversLicenseNumber", - "JPPassportNumber", - "JPResidentRegistrationNumber", - "JPSocialInsuranceNumber", - "JPMyNumberCorporate", - "JPMyNumberPersonal", - "JPResidenceCardNumber", - "LVPersonalCode", - "LTPersonalCode", - "LUNationalIdentificationNumberNatural", - "LUNationalIdentificationNumberNonNatural", - "MYIdentityCardNumber", - "MTIdentityCardNumber", - "MTTaxIDNumber", - "NLCitizensServiceNumber", - "NLCitizensServiceNumberV2", - "NLTaxIdentificationNumber", - "NLValueAddedTaxNumber", - "NZBankAccountNumber", - "NZDriversLicenseNumber", - "NZInlandRevenueNumber", - "NZMinistryOfHealthNumber", - "NZSocialWelfareNumber", - "NOIdentityNumber", - "PHUnifiedMultiPurposeIDNumber", - "PLIdentityCard", - "PLNationalID", - "PLNationalIDV2", - "PLPassportNumber", - "PLTaxIdentificationNumber", - "PLREGONNumber", - "PTCitizenCardNumber", - "PTCitizenCardNumberV2", - "PTTaxIdentificationNumber", - "ROPersonalNumericalCode", - "RUPassportNumberDomestic", - "RUPassportNumberInternational", - "SANationalID", - "SGNationalRegistrationIdentityCardNumber", - "SKPersonalNumber", - "SITaxIdentificationNumber", - "SIUniqueMasterCitizenNumber", - "ZAIdentificationNumber", - "KRResidentRegistrationNumber", - "ESDNI", - "ESSocialSecurityNumber", - "ESTaxIdentificationNumber", - "SQLServerConnectionString", - "SENationalID", - "SENationalIDV2", - "SEPassportNumber", - "SETaxIdentificationNumber", - "SWIFTCode", - "CHSocialSecurityNumber", - "TWNationalID", - "TWPassportNumber", - "TWResidentCertificate", - "THPopulationIdentificationCode", - "TRNationalIdentificationNumber", - "UKDriversLicenseNumber", - "UKElectoralRollNumber", - "UKNationalHealthNumber", - "UKNationalInsuranceNumber", - "UKUniqueTaxpayerNumber", - "USUKPassportNumber", - "USBankAccountNumber", - "USDriversLicenseNumber", - "USIndividualTaxpayerIdentification", - "USSocialSecurityNumber", - "UAPassportNumberDomestic", - "UAPassportNumberInternational", - "Organization", - "Email", - "URL", - "Age", - "PhoneNumber", - "IPAddress", - "Date", - "Person", - "Address", - "All", - "Default" - ] - }, - "type": "array", - "uniqueItems": true - }, - "ExtractiveSummarizationTaskParameters": { - "type": "object", - "description": "Supported parameters for an Extractive Summarization task.", - "properties": { - "sentenceCount": { - "type": "integer", - "default": 3 - }, - "sortBy": { - "$ref": "#/definitions/ExtractiveSummarizationSortingCriteria" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "ExtractiveSummarizationLROTask": { - "type": "object", - "description": "An object representing the task definition for an Extractive Summarization task.", - "properties": { - "parameters": { - "$ref": "#/definitions/ExtractiveSummarizationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "ExtractiveSummarization" - }, - "ExtractiveSummarizationResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/ExtractedSummaryDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "ExtractiveSummarizationSortingCriteria": { - "type": "string", - "default": "Offset", - "description": "The sorting criteria to use for the results of Extractive Summarization.", - "enum": [ - "Offset", - "Rank" - ], - "x-ms-enum": { - "name": "ExtractiveSummarizationSortingCriteria", - "modelAsString": true, - "values": [ - { - "name": "Offset", - "description": "Indicates that results should be sorted in order of appearance in the text.", - "value": "Offset" - }, - { - "name": "Rank", - "description": "Indicates that results should be sorted in order of importance (i.e. rank score) according to the model.", - "value": "Rank" - } - ] - } - }, - "ExtractedSummaryDocumentResult": { - "type": "object", - "properties": { - "sentences": { - "type": "array", - "description": "A ranked list of sentences representing the extracted summary.", - "items": { - "$ref": "#/definitions/ExtractedSummarySentence" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "sentences" - ] - }, - "ExtractedSummarySentence": { - "type": "object", - "required": [ - "text", - "rankScore", - "offset", - "length" - ], - "properties": { - "text": { - "type": "string", - "description": "The extracted sentence text." - }, - "rankScore": { - "type": "number", - "format": "double", - "description": "A double value representing the relevance of the sentence within the summary. Higher values indicate higher importance." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The sentence offset from the start of the document, based on the value of the parameter StringIndexType." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the sentence." - } - } - }, - "KeyPhraseTaskParameters": { - "type": "object", - "description": "Supported parameters for a Key Phrase Extraction task.", - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "KeyPhraseLROTask": { - "type": "object", - "description": "An object representing the task definition for a Key Phrase Extraction task.", - "properties": { - "parameters": { - "$ref": "#/definitions/KeyPhraseTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "KeyPhraseExtraction" - }, - "KeyPhraseTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/KeyPhraseResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "KeyPhraseExtractionResults" - }, - "KeyPhraseResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/KeyPhrasesDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "KeyPhrasesDocumentResult": { - "type": "object", - "properties": { - "keyPhrases": { - "type": "array", - "description": "A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.", - "items": { - "type": "string" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "keyPhrases" - ] - }, - "LanguageDetectionTaskParameters": { - "type": "object", - "description": "Supported parameters for a Language Detection task.", - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "LanguageDetectionTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/LanguageDetectionResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "LanguageDetectionResults" - }, - "LanguageDetectionResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "$ref": "#/definitions/LanguageDetectionDocumentResult" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "LanguageDetectionDocumentResult": { - "type": "object", - "properties": { - "detectedLanguage": { - "description": "Detected Language.", - "$ref": "#/definitions/DetectedLanguage" - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "detectedLanguage" - ] - }, - "DetectedLanguage": { - "type": "object", - "required": [ - "name", - "iso6391Name", - "confidenceScore" - ], - "properties": { - "name": { - "type": "string", - "description": "Long name of a detected language (e.g. English, French)." - }, - "iso6391Name": { - "type": "string", - "description": "A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr)." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true." - } - } - }, - "AnalyzeTextJobState": { - "allOf": [ - { - "$ref": "common.json#/definitions/JobState" - }, - { - "$ref": "#/definitions/TasksState" - }, - { - "$ref": "#/definitions/AnalyzeTextJobStatistics" - } - ] - }, - "Pagination": { - "properties": { - "nextLink": { - "type": "string" - } - }, - "type": "object" - }, - "AnalyzeTextJobStatistics": { - "properties": { - "statistics": { - "$ref": "common.json#/definitions/RequestStatistics" - } - }, - "type": "object" - }, - "TasksState": { - "properties": { - "tasks": { - "properties": { - "completed": { - "type": "integer" - }, - "failed": { - "type": "integer" - }, - "inProgress": { - "type": "integer" - }, - "total": { - "type": "integer" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - } - }, - "required": [ - "total", - "completed", - "failed", - "inProgress" - ], - "type": "object" - } - }, - "required": [ - "tasks" - ], - "type": "object" - }, - "AnalyzeTextLROResult": { - "type": "object", - "discriminator": "kind", - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextLROResultsKind" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskState" - }, - { - "$ref": "common.json#/definitions/TaskIdentifier" - } - ], - "required": [ - "kind" - ] - }, - "EntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityRecognitionLROResults" - }, - "CustomEntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomEntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomEntityRecognitionLROResults" - }, - "CustomSingleLabelClassificationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomLabelClassificationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomSingleLabelClassificationLROResults" - }, - "CustomMultiLabelClassificationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomLabelClassificationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomMultiLabelClassificationLROResults" - }, - "EntityLinkingLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntityLinkingResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityLinkingLROResults" - }, - "PiiEntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/PiiResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "PiiEntityRecognitionLROResults" - }, - "ExtractiveSummarizationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/ExtractiveSummarizationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "ExtractiveSummarizationLROResults" - }, - "HealthcareLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/HealthcareResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "HealthcareLROResults" - }, - "SentimentLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/SentimentResponse" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "SentimentAnalysisLROResults" - }, - "KeyPhraseExtractionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/KeyPhraseResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "KeyPhraseExtractionLROResults" - }, - "DocumentResponse": { - "type": "object", - "properties": {} - }, - "DocumentResult": { - "type": "object", - "required": [ - "id", - "warnings" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique, non-empty document identifier." - }, - "warnings": { - "type": "array", - "description": "Warnings encountered while processing document.", - "items": { - "$ref": "#/definitions/DocumentWarning" - } - }, - "statistics": { - "description": "if showStats=true was specified in the request this field will contain information about the document payload.", - "$ref": "#/definitions/DocumentStatistics" - } - } - }, - "DocumentDetectedLanguage": { - "type": "object", - "properties": { - "detectedLanguage": { - "type": "string", - "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." - } - } - }, - "DocumentError": { - "type": "object", - "required": [ - "id", - "error" - ], - "properties": { - "id": { - "type": "string", - "description": "Document Id." - }, - "error": { - "type": "object", - "description": "Document Error.", - "$ref": "common.json#/definitions/Error" - } - } - }, - "DocumentWarning": { - "type": "object", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "LongWordsInDocument", - "DocumentTruncated" - ], - "x-ms-enum": { - "name": "WarningCodeValue", - "modelAsString": true - }, - "description": "Error code." - }, - "message": { - "type": "string", - "description": "Warning message." - }, - "targetRef": { - "type": "string", - "description": "A JSON pointer reference indicating the target object." - } - } - }, - "DocumentStatistics": { - "type": "object", - "required": [ - "charactersCount", - "transactionsCount" - ], - "properties": { - "charactersCount": { - "type": "integer", - "format": "int32", - "description": "Number of text elements recognized in the document." - }, - "transactionsCount": { - "type": "integer", - "format": "int32", - "description": "Number of transactions for the document." - } - }, - "description": "if showStats=true was specified in the request this field will contain information about the document payload." - }, - "DocumentRequestStatistics": { - "type": "object", - "required": [ - "documentsCount", - "validDocumentsCount", - "erroneousDocumentsCount" - ], - "properties": { - "documentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of documents submitted in the request." - }, - "validDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." - }, - "erroneousDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/RequestStatistics" - } - ], - "description": "if showStats=true was specified in the request this field will contain information about the document request payload." - }, - "MultiLanguageInput": { - "type": "object", - "description": "Contains an input document to be analyzed by the service.", - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "A unique, non-empty document identifier." - }, - "text": { - "type": "string", - "description": "The input text to process." - }, - "language": { - "type": "string", - "description": "(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. For Auto Language Detection, use \"auto\". If not set, use \"en\" for English as default." - } - } - }, - "LanguageInput": { - "type": "object", - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique, non-empty document identifier." - }, - "text": { - "type": "string" - }, - "countryHint": { - "type": "string" - } - } - } - }, - "parameters": {} -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/common.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/common.json deleted file mode 100644 index 4ceef2d45f3c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/common.json +++ /dev/null @@ -1,837 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2022-07-01-preview" - }, - "paths": {}, - "definitions": { - "ErrorResponse": { - "type": "object", - "description": "Error response.", - "additionalProperties": false, - "properties": { - "error": { - "description": "The error object.", - "$ref": "#/definitions/Error" - } - }, - "required": [ - "error" - ] - }, - "Error": { - "type": "object", - "description": "The error object.", - "additionalProperties": true, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/ErrorCode" - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - }, - "target": { - "type": "string", - "description": "The target of the error." - }, - "details": { - "type": "array", - "description": "An array of details about specific errors that led to this reported error.", - "items": { - "$ref": "#/definitions/Error" - } - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "InnerErrorModel": { - "type": "object", - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", - "additionalProperties": false, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/InnerErrorCode" - }, - "message": { - "type": "string", - "description": "Error message." - }, - "details": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Error details." - }, - "target": { - "type": "string", - "description": "Error target." - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "ErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "ErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidArgument", - "Unauthorized", - "Forbidden", - "NotFound", - "ProjectNotFound", - "OperationNotFound", - "AzureCognitiveSearchNotFound", - "AzureCognitiveSearchIndexNotFound", - "TooManyRequests", - "AzureCognitiveSearchThrottling", - "AzureCognitiveSearchIndexLimitReached", - "InternalServerError", - "ServiceUnavailable", - "Timeout", - "QuotaExceeded", - "Conflict", - "Warning" - ] - }, - "InnerErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "InnerErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidParameterValue", - "KnowledgeBaseNotFound", - "AzureCognitiveSearchNotFound", - "AzureCognitiveSearchThrottling", - "ExtractionFailure", - "InvalidRequestBodyFormat", - "EmptyRequest", - "MissingInputDocuments", - "InvalidDocument", - "ModelVersionIncorrect", - "InvalidDocumentBatch", - "UnsupportedLanguageCode", - "InvalidCountryHint" - ] - }, - "Language": { - "type": "string", - "description": "Language of the text records. This is BCP-47 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." - }, - "StringIndexType": { - "type": "string", - "description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.", - "default": "TextElements_v8", - "enum": [ - "TextElements_v8", - "UnicodeCodePoint", - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "TextElements_v8", - "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." - }, - { - "value": "UnicodeCodePoint", - "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." - }, - { - "value": "Utf16CodeUnit", - "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - } - }, - "TaskState": { - "description": "Returns the current state of the task.", - "properties": { - "lastUpdateDateTime": { - "description": "The last updated time in UTC for the task.", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The status of the task at the mentioned last update time.", - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "TaskState" - } - } - }, - "required": [ - "status", - "lastUpdateDateTime" - ], - "type": "object" - }, - "TaskIdentifier": { - "type": "object", - "description": "Base task object.", - "properties": { - "taskName": { - "type": "string" - } - } - }, - "TaskParameters": { - "type": "object", - "description": "Base parameters object for a text analysis task.", - "properties": { - "loggingOptOut": { - "type": "boolean", - "default": false - } - } - }, - "PreBuiltTaskParameters": { - "type": "object", - "description": "Parameters object for a text analysis task using pre-built models.", - "properties": { - "modelVersion": { - "type": "string", - "default": "latest" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - } - ] - }, - "JobState": { - "properties": { - "displayName": { - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "type": "string" - }, - "jobId": { - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { - "enum": [ - "notStarted", - "running", - "succeeded", - "partiallyCompleted", - "failed", - "cancelled", - "cancelling" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "JobState" - } - }, - "errors": { - "items": { - "$ref": "#/definitions/Error" - }, - "type": "array" - }, - "nextLink": { - "type": "string" - } - }, - "required": [ - "jobId", - "lastUpdatedDateTime", - "createdDateTime", - "status" - ] - }, - "JobErrors": { - "properties": { - "errors": { - "items": { - "$ref": "#/definitions/Error" - }, - "type": "array" - } - }, - "type": "object" - }, - "InputError": { - "type": "object", - "description": "Contains details of errors encountered during a job execution.", - "required": [ - "id", - "error" - ], - "properties": { - "id": { - "type": "string", - "description": "The ID of the input." - }, - "error": { - "type": "object", - "description": "Error encountered.", - "$ref": "#/definitions/Error" - } - } - }, - "InputWarning": { - "type": "object", - "description": "Contains details of warnings encountered during a job execution.", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "description": "Warning code." - }, - "message": { - "type": "string", - "description": "Warning message." - }, - "targetRef": { - "type": "string", - "description": "A JSON pointer reference indicating the target object." - } - } - }, - "RequestStatistics": { - "type": "object", - "required": [ - "documentsCount", - "validDocumentsCount", - "erroneousDocumentsCount", - "transactionsCount" - ], - "properties": { - "documentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of documents submitted in the request." - }, - "validDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." - }, - "erroneousDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." - }, - "transactionsCount": { - "type": "integer", - "format": "int64", - "description": "Number of transactions for the request." - } - }, - "additionalProperties": true, - "description": "if showStats=true was specified in the request this field will contain information about the request payload." - }, - "PreBuiltResult": { - "properties": { - "errors": { - "type": "array", - "description": "Errors by document id.", - "items": { - "$ref": "#/definitions/InputError" - } - }, - "statistics": { - "$ref": "#/definitions/RequestStatistics" - }, - "modelVersion": { - "type": "string", - "description": "This field indicates which model is used for scoring." - } - }, - "required": [ - "errors", - "modelVersion" - ] - }, - "AnswersResult": { - "type": "object", - "description": "Represents List of Question Answers.", - "additionalProperties": false, - "properties": { - "answers": { - "type": "array", - "description": "Represents Answer Result list.", - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswer" - } - } - } - }, - "KnowledgeBaseAnswer": { - "type": "object", - "description": "Represents knowledge base answer.", - "additionalProperties": false, - "properties": { - "questions": { - "type": "array", - "description": "List of questions associated with the answer.", - "items": { - "type": "string" - } - }, - "answer": { - "type": "string", - "description": "Answer text." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidence", - "description": "Answer confidence score, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "id": { - "type": "integer", - "x-ms-client-name": "qnaId", - "description": "ID of the QnA result.", - "format": "int32" - }, - "source": { - "type": "string", - "description": "Source of QnA result." - }, - "metadata": { - "type": "object", - "description": "Metadata associated with the answer, useful to categorize or filter question answers.", - "additionalProperties": { - "type": "string" - } - }, - "dialog": { - "type": "object", - "$ref": "#/definitions/KnowledgeBaseAnswerDialog" - }, - "answerSpan": { - "type": "object", - "x-ms-client-name": "shortAnswer", - "description": "Answer span object of QnA with respect to user's question.", - "$ref": "#/definitions/AnswerSpan" - } - } - }, - "KnowledgeBaseAnswerDialog": { - "type": "object", - "description": "Dialog associated with Answer.", - "properties": { - "isContextOnly": { - "type": "boolean", - "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as search result for queries without context; otherwise, if false, ignores context and includes this QnA in search result." - }, - "prompts": { - "type": "array", - "description": "List of prompts associated with the answer.", - "maxItems": 20, - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswerPrompt" - } - } - } - }, - "KnowledgeBaseAnswerPrompt": { - "type": "object", - "description": "Prompt for an answer.", - "properties": { - "displayOrder": { - "type": "integer", - "description": "Index of the prompt - used in ordering of the prompts.", - "format": "int32" - }, - "qnaId": { - "type": "integer", - "description": "QnA ID corresponding to the prompt.", - "format": "int32" - }, - "displayText": { - "type": "string", - "description": "Text displayed to represent a follow up question prompt.", - "maxLength": 200 - } - } - }, - "AnswerSpan": { - "type": "object", - "description": "Answer span object of QnA.", - "additionalProperties": false, - "properties": { - "text": { - "type": "string", - "description": "Predicted text of answer span." - }, - "confidenceScore": { - "type": "number", - "x-ms-client-name": "confidence", - "description": "Predicted score of answer span, value ranges from 0 to 1.", - "format": "double", - "maximum": 1, - "minimum": 0 - }, - "offset": { - "type": "integer", - "description": "The answer span offset from the start of answer.", - "format": "int32" - }, - "length": { - "type": "integer", - "description": "The length of the answer span.", - "format": "int32" - } - } - }, - "AnswersOptions": { - "type": "object", - "description": "Parameters to query a knowledge base.", - "additionalProperties": false, - "properties": { - "qnaId": { - "type": "integer", - "description": "Exact QnA ID to fetch from the knowledge base, this field takes priority over question.", - "format": "int32" - }, - "question": { - "type": "string", - "description": "User question to query against the knowledge base." - }, - "top": { - "type": "integer", - "description": "Max number of answers to be returned for the question.", - "format": "int32" - }, - "userId": { - "type": "string", - "description": "Unique identifier for the user." - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidenceThreshold", - "description": "Minimum threshold score for answers, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "context": { - "x-ms-client-name": "answerContext", - "description": "Context object with previous QnA's information.", - "$ref": "#/definitions/KnowledgeBaseAnswerContext" - }, - "rankerType": { - "type": "string", - "x-ms-client-name": "rankerKind", - "description": "Type of ranker to be used.", - "x-ms-enum": { - "name": "RankerKind", - "modelAsString": true, - "values": [ - { - "value": "QuestionOnly", - "description": "Question only ranker." - }, - { - "value": "Default", - "description": "Default ranker." - } - ] - }, - "enum": [ - "Default", - "QuestionOnly" - ] - }, - "filters": { - "description": "Filter QnAs based on given metadata list and knowledge base sources.", - "$ref": "#/definitions/QueryFilters" - }, - "answerSpanRequest": { - "x-ms-client-name": "shortAnswerOptions", - "description": "To configure Answer span prediction feature.", - "$ref": "#/definitions/ShortAnswerOptions" - }, - "includeUnstructuredSources": { - "type": "boolean", - "description": "(Optional) Flag to enable Query over Unstructured Sources." - } - } - }, - "KnowledgeBaseAnswerContext": { - "type": "object", - "description": "Context object with previous QnA's information.", - "additionalProperties": false, - "required": [ - "previousQnaId" - ], - "properties": { - "previousQnaId": { - "type": "integer", - "description": "Previous turn top answer result QnA ID.", - "format": "int32" - }, - "previousUserQuery": { - "type": "string", - "x-ms-client-name": "previousQuestion", - "description": "Previous user query." - } - } - }, - "QueryFilters": { - "type": "object", - "description": "filters over knowledge base.", - "additionalProperties": false, - "properties": { - "metadataFilter": { - "type": "object", - "$ref": "#/definitions/MetadataFilter" - }, - "sourceFilter": { - "type": "object", - "$ref": "#/definitions/SourceFilter" - }, - "logicalOperation": { - "type": "string", - "description": "Logical operation used to join metadata filter with source filter.", - "$ref": "#/definitions/LogicalOperationKind", - "default": "AND" - } - } - }, - "MetadataFilter": { - "type": "object", - "description": "Find QnAs that are associated with the given list of metadata.", - "additionalProperties": false, - "properties": { - "metadata": { - "type": "array", - "items": { - "$ref": "#/definitions/MetadataRecord" - } - }, - "logicalOperation": { - "type": "string", - "description": "Operation used to join metadata filters.", - "$ref": "#/definitions/LogicalOperationKind", - "default": "AND" - } - } - }, - "MetadataRecord": { - "type": "object", - "description": "Object to provide the key value pair for each metadata.", - "additionalProperties": false, - "required": [ - "key", - "value" - ], - "properties": { - "key": { - "type": "string", - "description": "Metadata Key from Metadata dictionary used in the QnA." - }, - "value": { - "type": "string", - "description": "Metadata Value from Metadata dictionary used in the QnA." - } - } - }, - "SourceFilter": { - "type": "array", - "description": "Find QnAs that are associated with any of the given list of sources in knowledge base.", - "items": { - "type": "string" - } - }, - "LogicalOperationKind": { - "type": "string", - "description": "Set to 'OR' or 'AND' for using corresponding logical operation.", - "x-ms-enum": { - "name": "LogicalOperationKind", - "modelAsString": true - }, - "enum": [ - "AND", - "OR" - ] - }, - "ShortAnswerOptions": { - "type": "object", - "description": "To configure Answer span prediction feature.", - "additionalProperties": false, - "required": [ - "enable" - ], - "properties": { - "enable": { - "type": "boolean", - "description": "Enable or disable Answer Span prediction.", - "enum": [ - true - ], - "x-ms-enum": { - "name": "enable", - "modelAsString": false - } - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidenceThreshold", - "description": "Minimum threshold score required to include an answer span, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "topAnswersWithSpan": { - "type": "integer", - "x-ms-client-name": "top", - "description": "Number of Top answers to be considered for span prediction from 1 to 10.", - "format": "int32", - "maximum": 10, - "minimum": 1 - } - } - } - }, - "parameters": { - "Endpoint": { - "name": "endpoint", - "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - "ProjectNameQueryParameter": { - "name": "projectName", - "in": "query", - "required": true, - "type": "string", - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "ProjectNamePathParameter": { - "name": "projectName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 100, - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNameQueryParameter": { - "name": "deploymentName", - "in": "query", - "required": true, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNamePathParameter": { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - }, - "TopParameter": { - "name": "top", - "in": "query", - "description": "The maximum number of resources to return from the collection.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "SkipParameter": { - "name": "skip", - "in": "query", - "description": "An offset into the collection of the first resource to be returned.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "MaxPageSizeParameter": { - "name": "maxpagesize", - "in": "query", - "description": "The maximum number of resources to include in a single response.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "ShowStats": { - "name": "showStats", - "in": "query", - "description": "(Optional) if set to true, response will contain request and document level statistics.", - "type": "boolean", - "required": false, - "x-ms-parameter-location": "method" - }, - "JobId": { - "description": "Job ID", - "format": "uuid", - "in": "path", - "name": "jobId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json deleted file mode 100644 index aaf7d8431aa0..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json deleted file mode 100644 index dcdc4e0e088f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/merge-patch+json", - "api-version": "2022-07-01-preview", - "projectName": "myproject", - "body": { - "projectName": "myproject", - "language": "en", - "projectKind": "Conversation", - "description": "This is a sample conversation project.", - "multilingual": false - } - }, - "responses": { - "201": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "projectKind": "Conversation", - "projectName": "myproject", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - } - }, - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "Conversation", - "projectName": "myproject", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json deleted file mode 100644 index c7c46cfb9a30..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp", - "deploymentName": "staging" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json deleted file mode 100644 index e2aba1d4cb8b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model2" - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json deleted file mode 100644 index 361bb0ef3fe9..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "myproject" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json deleted file mode 100644 index 51f2ac16b6c7..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp", - "deploymentName": "production", - "body": { - "trainedModelLabel": "model1" - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json deleted file mode 100644 index ec20347ec755..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp", - "stringIndexType": "Utf16CodeUnit" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json deleted file mode 100644 index 2cd8cd261428..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp", - "deploymentName": "staging" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "deploymentName": "staging", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T15:53:04Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json deleted file mode 100644 index 30f391e66521..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp", - "deploymentName": "production", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json deleted file mode 100644 index 3c168cf7a55e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp", - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "resultUrl": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version={api-version}", - "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", - "createdDateTime": "2022-04-18T15:23:07Z", - "lastUpdatedDateTime": "2022-04-18T15:23:08Z", - "expirationDateTime": "2022-04-25T15:23:07Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json deleted file mode 100644 index 05f5a144cf3f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp", - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", - "createdDateTime": "2022-04-18T15:17:20Z", - "lastUpdatedDateTime": "2022-04-18T15:17:22Z", - "expirationDateTime": "2022-04-25T15:17:20Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json deleted file mode 100644 index bf4a5f28ca0b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "label": "model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49Z", - "lastTrainingDurationInSeconds": 186, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json deleted file mode 100644 index ab0b06a26f59..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json +++ /dev/null @@ -1,284 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1", - "stringIndexType": "Utf16CodeUnit", - "maxpagesize": 10 - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "text": "send the email", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [], - "predictedEntities": [] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "send a mail to daniel", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 15, - "length": 6 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 15, - "length": 6 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "i forgot to add an important part to that email to james . please set it up to edit", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 51, - "length": 5 - } - ], - "predictedEntities": [ - { - "category": "Category", - "offset": 19, - "length": 9 - }, - { - "category": "ContactName", - "offset": 51, - "length": 5 - } - ] - }, - "intentsResult": { - "expectedIntent": "AddMore", - "predictedIntent": "AddMore" - } - }, - { - "text": "send email to a and tian", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 14, - "length": 1 - }, - { - "category": "ContactName", - "offset": 20, - "length": 4 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 14, - "length": 1 - }, - { - "category": "ContactName", - "offset": 20, - "length": 4 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "send thomas an email", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 5, - "length": 6 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 5, - "length": 6 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "i need to add more to the email message i am sending to vincent", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 56, - "length": 7 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 56, - "length": 7 - } - ] - }, - "intentsResult": { - "expectedIntent": "AddMore", - "predictedIntent": "AddMore" - } - }, - { - "text": "send an email to lily roth and abc123@microsoft.com", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 17, - "length": 9 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 17, - "length": 9 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "i need to add something else to my email to cheryl", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 44, - "length": 6 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 44, - "length": 6 - } - ] - }, - "intentsResult": { - "expectedIntent": "AddMore", - "predictedIntent": "AddMore" - } - }, - { - "text": "send an email to larry , joseph and billy larkson", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 17, - "length": 5 - }, - { - "category": "ContactName", - "offset": 25, - "length": 6 - }, - { - "category": "ContactName", - "offset": 36, - "length": 13 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 17, - "length": 5 - }, - { - "category": "ContactName", - "offset": 25, - "length": 6 - }, - { - "category": "ContactName", - "offset": 36, - "length": 13 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "send mail to dorothy", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 13, - "length": 7 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 13, - "length": 7 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - } - ], - "nextLink": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version={api-version}&top=2147483637&skip={maxpagesize}&maxpagesize={maxpagesize}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json deleted file mode 100644 index 9172c9a2cbb6..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json +++ /dev/null @@ -1,526 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "entitiesEvaluation": { - "confusionMatrix": { - "Attachment": { - "Attachment": { - "normalizedValue": 100.0, - "rawValue": 3.0 - } - }, - "Category": { - "Category": { - "normalizedValue": 91.666664, - "rawValue": 11.0 - }, - "$none": { - "normalizedValue": 8.333333, - "rawValue": 1.0 - } - }, - "ContactName": { - "ContactName": { - "normalizedValue": 91.666664, - "rawValue": 22.0 - }, - "SenderName": { - "normalizedValue": 4.1666665, - "rawValue": 1.0 - }, - "$none": { - "normalizedValue": 4.1666665, - "rawValue": 1.0 - } - }, - "Date": { - "Date": { - "normalizedValue": 100.0, - "rawValue": 2.0 - } - }, - "EmailSubject": { - "EmailSubject": { - "normalizedValue": 93.33333, - "rawValue": 9.333334 - }, - "$none": { - "normalizedValue": 6.6666665, - "rawValue": 0.6666667 - } - }, - "FromRelationshipName": { - "FromRelationshipName": { - "normalizedValue": 100.0, - "rawValue": 1.0 - } - }, - "Line": { - "Line": { - "normalizedValue": 100.0, - "rawValue": 2.0 - } - }, - "Message": { - "Message": { - "normalizedValue": 81.2063, - "rawValue": 6.496504 - }, - "EmailSubject": { - "normalizedValue": 7.43007, - "rawValue": 0.5944056 - }, - "$none": { - "normalizedValue": 9.120047, - "rawValue": 0.7296037 - }, - "Date": { - "normalizedValue": 2.2435899, - "rawValue": 0.17948718 - } - }, - "OrderReference": { - "OrderReference": { - "normalizedValue": 100.0, - "rawValue": 17.0 - } - }, - "PositionReference": { - "$none": { - "normalizedValue": 100.0, - "rawValue": 1.0 - } - }, - "RelationshipName": { - "RelationshipName": { - "normalizedValue": 66.666664, - "rawValue": 2.0 - }, - "$none": { - "normalizedValue": 33.333332, - "rawValue": 1.0 - } - }, - "SearchTexts": { - "SearchTexts": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "SenderName": { - "SenderName": { - "normalizedValue": 88.888885, - "rawValue": 8.0 - }, - "ContactName": { - "normalizedValue": 11.111111, - "rawValue": 1.0 - } - }, - "Time": { - "$none": { - "normalizedValue": 100.0, - "rawValue": 2.0 - } - }, - "$none": { - "$none": { - "normalizedValue": 99.739265, - "rawValue": 162.575 - }, - "Category": { - "normalizedValue": 0.2607362, - "rawValue": 0.425 - } - } - }, - "entities": { - "ContactName": { - "f1": 0.9361702799797058, - "precision": 0.95652174949646, - "recall": 0.9166666865348816, - "truePositiveCount": 22, - "trueNegativeCount": 0, - "falsePositiveCount": 1, - "falseNegativeCount": 2 - }, - "Category": { - "f1": 0.8799999952316284, - "precision": 0.8461538553237915, - "recall": 0.9166666865348816, - "truePositiveCount": 11, - "trueNegativeCount": 0, - "falsePositiveCount": 2, - "falseNegativeCount": 1 - }, - "SenderName": { - "f1": 0.8888888955116272, - "precision": 0.8888888955116272, - "recall": 0.8888888955116272, - "truePositiveCount": 8, - "trueNegativeCount": 0, - "falsePositiveCount": 1, - "falseNegativeCount": 1 - }, - "EmailSubject": { - "f1": 0.8181817531585693, - "precision": 0.75, - "recall": 0.8999999761581421, - "truePositiveCount": 9, - "trueNegativeCount": 0, - "falsePositiveCount": 3, - "falseNegativeCount": 1 - }, - "Message": { - "f1": 0.75, - "precision": 0.75, - "recall": 0.75, - "truePositiveCount": 6, - "trueNegativeCount": 0, - "falsePositiveCount": 2, - "falseNegativeCount": 2 - }, - "Date": { - "f1": 0.800000011920929, - "precision": 0.6666666865348816, - "recall": 1.0, - "truePositiveCount": 2, - "trueNegativeCount": 0, - "falsePositiveCount": 1, - "falseNegativeCount": 0 - }, - "OrderReference": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 17, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "SearchTexts": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Attachment": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 3, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "RelationshipName": { - "f1": 0.800000011920929, - "precision": 1.0, - "recall": 0.6666666865348816, - "truePositiveCount": 2, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 1 - }, - "Line": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 2, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Time": { - "f1": 0.0, - "precision": 0.0, - "recall": 0.0, - "truePositiveCount": 0, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 2 - }, - "FromRelationshipName": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 1, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "PositionReference": { - "f1": 0.0, - "precision": 0.0, - "recall": 0.0, - "truePositiveCount": 0, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 1 - } - }, - "microF1": 0.8923077, - "microPrecision": 0.8969072, - "microRecall": 0.8877551, - "macroF1": 0.7766601, - "macroPrecision": 0.7755879, - "macroRecall": 0.78849214 - }, - "intentsEvaluation": { - "confusionMatrix": { - "AddFlag": { - "AddFlag": { - "normalizedValue": 100.0, - "rawValue": 6.0 - } - }, - "AddMore": { - "AddMore": { - "normalizedValue": 100.0, - "rawValue": 17.0 - } - }, - "Cancel": { - "Cancel": { - "normalizedValue": 100.0, - "rawValue": 9.0 - } - }, - "CheckMessages": { - "CheckMessages": { - "normalizedValue": 100.0, - "rawValue": 9.0 - } - }, - "Confirm": { - "Confirm": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "Delete": { - "Delete": { - "normalizedValue": 100.0, - "rawValue": 5.0 - } - }, - "Forward": { - "Forward": { - "normalizedValue": 100.0, - "rawValue": 6.0 - } - }, - "None": { - "None": { - "normalizedValue": 100.0, - "rawValue": 1.0 - } - }, - "QueryLastText": { - "QueryLastText": { - "normalizedValue": 100.0, - "rawValue": 6.0 - } - }, - "ReadAloud": { - "ReadAloud": { - "normalizedValue": 100.0, - "rawValue": 16.0 - } - }, - "Reply": { - "Reply": { - "normalizedValue": 100.0, - "rawValue": 6.0 - } - }, - "SearchMessages": { - "SearchMessages": { - "normalizedValue": 100.0, - "rawValue": 9.0 - } - }, - "SendEmail": { - "SendEmail": { - "normalizedValue": 100.0, - "rawValue": 20.0 - } - }, - "ShowNext": { - "ShowNext": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "ShowPrevious": { - "ShowPrevious": { - "normalizedValue": 100.0, - "rawValue": 3.0 - } - } - }, - "intents": { - "AddMore": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 17, - "trueNegativeCount": 104, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Cancel": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 9, - "trueNegativeCount": 112, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "SendEmail": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 20, - "trueNegativeCount": 101, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "CheckMessages": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 9, - "trueNegativeCount": 112, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "AddFlag": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 6, - "trueNegativeCount": 115, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Reply": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 6, - "trueNegativeCount": 115, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "ReadAloud": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 16, - "trueNegativeCount": 105, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "QueryLastText": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 6, - "trueNegativeCount": 115, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "SearchMessages": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 9, - "trueNegativeCount": 112, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Delete": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 5, - "trueNegativeCount": 116, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Forward": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 6, - "trueNegativeCount": 115, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Confirm": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 117, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "ShowNext": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 117, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "ShowPrevious": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 3, - "trueNegativeCount": 118, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "None": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 1, - "trueNegativeCount": 120, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - } - }, - "microF1": 1.0, - "microPrecision": 1.0, - "microRecall": 1.0, - "macroF1": 1.0, - "macroPrecision": 1.0, - "macroRecall": 1.0 - }, - "evaluationOptions": { - "kind": "percentage", - "trainingSplitPercentage": 80, - "testingSplitPercentage": 20 - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json deleted file mode 100644 index 6428669c609d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "myproject" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "Conversation", - "projectName": "myproject", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json deleted file mode 100644 index 53e48a5724fa..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000", - "createdDateTime": "2022-04-18T14:02:34Z", - "lastUpdatedDateTime": "2022-04-18T14:02:34Z", - "expirationDateTime": "2022-04-25T14:02:34Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json deleted file mode 100644 index c4bd91bf47f5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json +++ /dev/null @@ -1,398 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectKind": "Conversation" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "languageName": "English", - "languageCode": "en" - }, - { - "languageName": "English", - "languageCode": "en-us" - }, - { - "languageName": "English (UK)", - "languageCode": "en-gb" - }, - { - "languageName": "French", - "languageCode": "fr" - }, - { - "languageName": "Italian", - "languageCode": "it" - }, - { - "languageName": "Spanish", - "languageCode": "es" - }, - { - "languageName": "German", - "languageCode": "de" - }, - { - "languageName": "Portuguese (Brazil)", - "languageCode": "pt-br" - }, - { - "languageName": "Portuguese (Portugal)", - "languageCode": "pt-pt" - }, - { - "languageName": "Chinese (Simplified)", - "languageCode": "zh-hans" - }, - { - "languageName": "Japanese", - "languageCode": "ja" - }, - { - "languageName": "Korean", - "languageCode": "ko" - }, - { - "languageName": "Dutch", - "languageCode": "nl" - }, - { - "languageName": "Hindi", - "languageCode": "hi" - }, - { - "languageName": "Turkish", - "languageCode": "tr" - }, - { - "languageName": "Gujarati", - "languageCode": "gu" - }, - { - "languageName": "Marathi", - "languageCode": "mr" - }, - { - "languageName": "Tamil", - "languageCode": "ta" - }, - { - "languageName": "Telugu", - "languageCode": "te" - }, - { - "languageName": "Zulu", - "languageCode": "zu" - }, - { - "languageName": "Afrikaans", - "languageCode": "af" - }, - { - "languageName": "Amharic", - "languageCode": "am" - }, - { - "languageName": "Arabic", - "languageCode": "ar" - }, - { - "languageName": "Assamese", - "languageCode": "as" - }, - { - "languageName": "Azerbaijani", - "languageCode": "az" - }, - { - "languageName": "Belarusian", - "languageCode": "be" - }, - { - "languageName": "Bulgarian", - "languageCode": "bg" - }, - { - "languageName": "Breton", - "languageCode": "br" - }, - { - "languageName": "Bosnian", - "languageCode": "bs" - }, - { - "languageName": "Catalan", - "languageCode": "ca" - }, - { - "languageName": "Czech", - "languageCode": "cs" - }, - { - "languageName": "Welsh", - "languageCode": "cy" - }, - { - "languageName": "Danish", - "languageCode": "da" - }, - { - "languageName": "Greek", - "languageCode": "el" - }, - { - "languageName": "Esperanto", - "languageCode": "eo" - }, - { - "languageName": "Estonian", - "languageCode": "et" - }, - { - "languageName": "Basque", - "languageCode": "eu" - }, - { - "languageName": "Persian", - "languageCode": "fa" - }, - { - "languageName": "Finnish", - "languageCode": "fi" - }, - { - "languageName": "Western Frisian", - "languageCode": "fy" - }, - { - "languageName": "Irish", - "languageCode": "ga" - }, - { - "languageName": "Scottish Gaelic", - "languageCode": "gd" - }, - { - "languageName": "Galician", - "languageCode": "gl" - }, - { - "languageName": "Hausa", - "languageCode": "ha" - }, - { - "languageName": "Hebrew", - "languageCode": "he" - }, - { - "languageName": "Croatian", - "languageCode": "hr" - }, - { - "languageName": "Hungarian", - "languageCode": "hu" - }, - { - "languageName": "Armenian", - "languageCode": "hy" - }, - { - "languageName": "Indonesian", - "languageCode": "id" - }, - { - "languageName": "Javanese", - "languageCode": "jv" - }, - { - "languageName": "Georgian", - "languageCode": "ka" - }, - { - "languageName": "Kazakh", - "languageCode": "kk" - }, - { - "languageName": "Khmer", - "languageCode": "km" - }, - { - "languageName": "Kannada", - "languageCode": "kn" - }, - { - "languageName": "Kurdish (Kurmanji)", - "languageCode": "ku" - }, - { - "languageName": "Kyrgyz", - "languageCode": "ky" - }, - { - "languageName": "Latin", - "languageCode": "la" - }, - { - "languageName": "Lao", - "languageCode": "lo" - }, - { - "languageName": "Lithuanian", - "languageCode": "lt" - }, - { - "languageName": "Latvian", - "languageCode": "lv" - }, - { - "languageName": "Malagasy", - "languageCode": "mg" - }, - { - "languageName": "Macedonian", - "languageCode": "mk" - }, - { - "languageName": "Malayalam", - "languageCode": "ml" - }, - { - "languageName": "Mongolian", - "languageCode": "mn" - }, - { - "languageName": "Malay", - "languageCode": "ms" - }, - { - "languageName": "Burmese", - "languageCode": "my" - }, - { - "languageName": "Nepali", - "languageCode": "ne" - }, - { - "languageName": "Norwegian (Bokmal)", - "languageCode": "nb" - }, - { - "languageName": "Odia", - "languageCode": "or" - }, - { - "languageName": "Punjabi", - "languageCode": "pa" - }, - { - "languageName": "Polish", - "languageCode": "pl" - }, - { - "languageName": "Pashto", - "languageCode": "ps" - }, - { - "languageName": "Romanian", - "languageCode": "ro" - }, - { - "languageName": "Russian", - "languageCode": "ru" - }, - { - "languageName": "Sanskrit", - "languageCode": "sa" - }, - { - "languageName": "Sindhi", - "languageCode": "sd" - }, - { - "languageName": "Sinhala", - "languageCode": "si" - }, - { - "languageName": "Slovak", - "languageCode": "sk" - }, - { - "languageName": "Slovenian", - "languageCode": "sl" - }, - { - "languageName": "Somali", - "languageCode": "so" - }, - { - "languageName": "Albanian", - "languageCode": "sq" - }, - { - "languageName": "Serbian", - "languageCode": "sr" - }, - { - "languageName": "Sundanese", - "languageCode": "su" - }, - { - "languageName": "Swedish", - "languageCode": "sv" - }, - { - "languageName": "Swahili", - "languageCode": "sw" - }, - { - "languageName": "Thai", - "languageCode": "th" - }, - { - "languageName": "Filipino", - "languageCode": "tl" - }, - { - "languageName": "Uyghur", - "languageCode": "ug" - }, - { - "languageName": "Ukrainian", - "languageCode": "uk" - }, - { - "languageName": "Urdu", - "languageCode": "ur" - }, - { - "languageName": "Uzbek", - "languageCode": "uz" - }, - { - "languageName": "Vietnamese", - "languageCode": "vi" - }, - { - "languageName": "Xhosa", - "languageCode": "xh" - }, - { - "languageName": "Yiddish", - "languageCode": "yi" - }, - { - "languageName": "Chinese (Traditional)", - "languageCode": "zh-hant" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json deleted file mode 100644 index 737f3e2ebc56..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json +++ /dev/null @@ -1,98 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "language": "en" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "category": "Person.Name", - "description": "Name of an individual", - "examples": "john, Sam, Lisa" - }, - { - "category": "General.Event", - "description": "Important events", - "examples": "World War two, Covid 19" - }, - { - "category": "General.Organization", - "description": "Companies and corporations", - "examples": "Microsoft, Amazon" - }, - { - "category": "Choice.Boolean", - "description": "boolean choice", - "examples": "yes, no, agreed" - }, - { - "category": "Quantity.Age", - "description": "Age of a person or thing", - "examples": "10-month-old, 19 years old, 58 year-old" - }, - { - "category": "Quantity.NumberRange", - "description": "a numeric interval", - "examples": "between 25 and 35, 25-35" - }, - { - "category": "Quantity.Number", - "description": "A cardinal number in numeric or text form", - "examples": "ten, forty two, 3.141, 10K" - }, - { - "category": "Quantity.Percentage", - "description": "A percentage, using the symbol % or the word \"percent\"", - "examples": "10%, 5.6 percent" - }, - { - "category": "Quantity.Ordinal", - "description": "An ordinal number in numeric or text form", - "examples": "first, second, tenth, 1st, 2nd, 10th" - }, - { - "category": "Quantity.Dimension", - "description": "Spacial dimensions, including length, distance, area, and volume", - "examples": "2 miles, 650 square kilometres, 9,350 feet" - }, - { - "category": "Quantity.Temperature", - "description": "A temperature in celsius or fahrenheit", - "examples": "32F, 34 degrees celsius, 2 deg C" - }, - { - "category": "Quantity.Currency", - "description": "Monetary amounts, including currency", - "examples": "1000.00 US dollars, £20.00, $ 67.5 B" - }, - { - "category": "DateTime", - "description": "exact date values", - "examples": "May 11th" - }, - { - "category": "Email", - "description": "Email addresses", - "examples": "user@example.net, user_name@example.com, user.Name12@example.net" - }, - { - "category": "Phone Number", - "description": "US phone numbers", - "examples": "123-456-7890, +1 123 456 789, (123)456-789" - }, - { - "category": "URL", - "description": "Websites URLs and links", - "examples": "www.example.com, http://example.net?name=my_name&age=10" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json deleted file mode 100644 index 00c532abb041..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectKind": "Conversation" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "trainingConfigVersion": "2022-05-01", - "modelExpirationDate": "2022-10-28" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json deleted file mode 100644 index b47ae828197b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp", - "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", - "createdDateTime": "2022-04-18T16:09:50Z", - "lastUpdatedDateTime": "2022-04-18T16:09:58Z", - "expirationDateTime": "2022-04-25T16:09:50Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json deleted file mode 100644 index 6e7ed1893145..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "result": { - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "trainingMode": "standard", - "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", - "trainingStatus": { - "percentComplete": 3, - "startDateTime": "2022-04-18T15:45:06.8190649Z", - "status": "running" - }, - "evaluationStatus": { - "percentComplete": 0, - "status": "notStarted" - } - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:45:48Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "running" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json deleted file mode 100644 index 89f3927341e2..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp", - "body": { - "projectFileVersion": "2022-05-01", - "stringIndexType": "Utf16CodeUnit", - "metadata": { - "projectKind": "Conversation", - "settings": { - "confidenceThreshold": 0.7 - }, - "projectName": "EmailApp", - "multilingual": true, - "description": "Trying out CLU", - "language": "en-us" - }, - "assets": { - "projectKind": "Conversation", - "intents": [ - { - "category": "Read" - }, - { - "category": "Delete" - } - ], - "entities": [ - { - "category": "Sender" - } - ], - "utterances": [ - { - "text": "Open Blake's email", - "dataset": "Train", - "intent": "Read", - "entities": [ - { - "category": "Sender", - "offset": 5, - "length": 5 - } - ] - }, - { - "text": "Delete last email", - "language": "en-gb", - "dataset": "Test", - "intent": "Delete", - "entities": [] - } - ] - } - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json deleted file mode 100644 index 774521905976..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "deploymentName": "production", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T16:03:51Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01" - }, - { - "deploymentName": "staging", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T15:53:04Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json deleted file mode 100644 index 3f701f8aab5b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "label": "model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49Z", - "lastTrainingDurationInSeconds": 186, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01" - }, - { - "label": "model2", - "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", - "lastTrainedDateTime": "2022-04-18T17:25:22Z", - "lastTrainingDurationInSeconds": 192, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json deleted file mode 100644 index d991ac728916..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "createdDateTime": "2022-04-18T14:03:16Z", - "lastModifiedDateTime": "2022-04-18T14:03:16Z", - "projectKind": "Conversation", - "projectName": "myproject1", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - }, - { - "createdDateTime": "2022-04-18T14:03:12Z", - "lastModifiedDateTime": "2022-04-18T14:03:12Z", - "projectKind": "Conversation", - "projectName": "myproject", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json deleted file mode 100644 index e2348742182d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json +++ /dev/null @@ -1,90 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "result": { - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "trainingMode": "advanced", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T15:45:06.8190649Z", - "endDateTime": "2022-04-18T15:47:19.2639682Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T15:47:19.2734976Z", - "endDateTime": "2022-04-18T15:47:23.8378892Z", - "status": "succeeded" - } - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:47:50Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "succeeded" - }, - { - "result": { - "modelLabel": "model2", - "trainingConfigVersion": "2022-05-01", - "trainingMode": "standard", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:22:39.3663023Z", - "endDateTime": "2022-04-18T17:24:51.9440947Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:24:51.9571747Z", - "endDateTime": "2022-04-18T17:24:58.1427823Z", - "status": "succeeded" - } - }, - "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", - "createdDateTime": "2022-04-18T17:22:11Z", - "lastUpdatedDateTime": "2022-04-18T17:25:23Z", - "expirationDateTime": "2022-04-25T17:22:11Z", - "status": "succeeded" - }, - { - "result": { - "modelLabel": "model2", - "trainingConfigVersion": "2022-05-01", - "trainingMode": "standard", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:44:41.388358Z", - "endDateTime": "2022-04-18T17:50:29.5675101Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:50:29.5808461Z", - "endDateTime": "2022-04-18T17:50:35.3482185Z", - "status": "succeeded" - } - }, - "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", - "createdDateTime": "2022-04-18T17:44:04Z", - "lastUpdatedDateTime": "2022-04-18T17:51:11Z", - "expirationDateTime": "2022-04-25T17:44:04Z", - "status": "succeeded" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json deleted file mode 100644 index 1b84a9b9add6..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp", - "body": { - "firstDeploymentName": "production", - "secondDeploymentName": "staging" - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json deleted file mode 100644 index b33f276d5805..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "EmailApp", - "body": { - "modelLabel": "model1", - "trainingMode": "standard", - "trainingConfigVersion": "latest", - "evaluationOptions": { - "kind": "percentage", - "testingSplitPercentage": 20, - "trainingSplitPercentage": 80 - } - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json deleted file mode 100644 index fd0e0f9ad28c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulCreateProject.json deleted file mode 100644 index c8a0e4136b93..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulCreateProject.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/merge-patch+json", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "body": { - "projectName": "LoanAgreements", - "language": "en", - "projectKind": "CustomEntityRecognition", - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "multilingual": false, - "storageInputContainerName": "loanagreements" - } - }, - "responses": { - "201": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - } - }, - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json deleted file mode 100644 index 0a59b87931ff..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "deploymentName": "staging" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/staging/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulDeleteModel.json deleted file mode 100644 index 07a804dc2431..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulDeleteModel.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model2" - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulDeleteProject.json deleted file mode 100644 index f87147e91f8b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulDeleteProject.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulDeployProject.json deleted file mode 100644 index ae8d43ffe3ff..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulDeployProject.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "deploymentName": "production", - "body": { - "trainedModelLabel": "model1" - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulExportProject.json deleted file mode 100644 index 1a88fbb7da8d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulExportProject.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "stringIndexType": "Utf16CodeUnit" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetDeployment.json deleted file mode 100644 index e30154bb016f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetDeployment.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "deploymentName": "staging" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "deploymentName": "staging", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T15:53:04Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json deleted file mode 100644 index b8012fd9c4d5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "deploymentName": "production", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetExportStatus.json deleted file mode 100644 index cceff50a159b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetExportStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "resultUrl": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version={api-version}", - "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", - "createdDateTime": "2022-04-18T15:23:07Z", - "lastUpdatedDateTime": "2022-04-18T15:23:08Z", - "expirationDateTime": "2022-04-25T15:23:07Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetImportStatus.json deleted file mode 100644 index c62cc023fe53..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetImportStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", - "createdDateTime": "2022-04-18T15:17:20Z", - "lastUpdatedDateTime": "2022-04-18T15:17:22Z", - "expirationDateTime": "2022-04-25T15:17:20Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetModel.json deleted file mode 100644 index 306eaa09c870..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetModel.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "label": "model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49Z", - "lastTrainingDurationInSeconds": 186, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json deleted file mode 100644 index 7ddec32fb110..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json +++ /dev/null @@ -1,295 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model2", - "stringIndexType": "Utf16CodeUnit", - "maxpagesize": 10 - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "location": "11.txt", - "language": "en-us", - "projectKind": "CustomEntityRecognition", - "customEntityRecognitionResult": { - "entities": [ - { - "expectedEntities": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "BorrowerName", - "offset": 160, - "length": 13 - }, - { - "category": "BorrowerAddress", - "offset": 181, - "length": 34 - }, - { - "category": "BorrowerCity", - "offset": 225, - "length": 6 - }, - { - "category": "BorrowerState", - "offset": 242, - "length": 8 - }, - { - "category": "LenderName", - "offset": 271, - "length": 12 - }, - { - "category": "LenderAddress", - "offset": 310, - "length": 20 - }, - { - "category": "LenderCity", - "offset": 340, - "length": 8 - }, - { - "category": "LenderState", - "offset": 359, - "length": 11 - }, - { - "category": "LoanAmountWords", - "offset": 448, - "length": 52 - }, - { - "category": "LoanAmountNumbers", - "offset": 502, - "length": 10 - }, - { - "category": "Interest", - "offset": 588, - "length": 2 - } - ], - "predictedEntities": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "BorrowerName", - "offset": 160, - "length": 13 - }, - { - "category": "BorrowerAddress", - "offset": 200, - "length": 15 - }, - { - "category": "BorrowerCity", - "offset": 225, - "length": 6 - }, - { - "category": "BorrowerState", - "offset": 242, - "length": 8 - }, - { - "category": "LenderName", - "offset": 271, - "length": 12 - }, - { - "category": "LenderAddress", - "offset": 310, - "length": 20 - }, - { - "category": "LenderCity", - "offset": 340, - "length": 8 - }, - { - "category": "LenderState", - "offset": 359, - "length": 11 - }, - { - "category": "LoanAmountWords", - "offset": 448, - "length": 52 - }, - { - "category": "LoanAmountNumbers", - "offset": 502, - "length": 10 - }, - { - "category": "Interest", - "offset": 588, - "length": 2 - } - ], - "regionOffset": 0, - "regionLength": 1780 - } - ] - } - }, - { - "location": "01.txt", - "language": "en-us", - "projectKind": "CustomEntityRecognition", - "customEntityRecognitionResult": { - "entities": [ - { - "expectedEntities": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "BorrowerName", - "offset": 160, - "length": 13 - }, - { - "category": "BorrowerAddress", - "offset": 200, - "length": 13 - }, - { - "category": "BorrowerCity", - "offset": 223, - "length": 9 - }, - { - "category": "BorrowerState", - "offset": 243, - "length": 8 - }, - { - "category": "LenderName", - "offset": 273, - "length": 14 - }, - { - "category": "LenderAddress", - "offset": 314, - "length": 15 - }, - { - "category": "LenderCity", - "offset": 339, - "length": 10 - }, - { - "category": "LenderState", - "offset": 360, - "length": 8 - }, - { - "category": "LoanAmountWords", - "offset": 446, - "length": 66 - }, - { - "category": "LoanAmountNumbers", - "offset": 514, - "length": 11 - }, - { - "category": "Interest", - "offset": 601, - "length": 2 - } - ], - "predictedEntities": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "BorrowerName", - "offset": 160, - "length": 13 - }, - { - "category": "BorrowerAddress", - "offset": 200, - "length": 13 - }, - { - "category": "BorrowerCity", - "offset": 223, - "length": 9 - }, - { - "category": "BorrowerState", - "offset": 243, - "length": 8 - }, - { - "category": "LenderName", - "offset": 273, - "length": 14 - }, - { - "category": "LenderAddress", - "offset": 314, - "length": 15 - }, - { - "category": "LenderCity", - "offset": 339, - "length": 10 - }, - { - "category": "LenderState", - "offset": 360, - "length": 8 - }, - { - "category": "LoanAmountWords", - "offset": 446, - "length": 66 - }, - { - "category": "LoanAmountNumbers", - "offset": 514, - "length": 11 - }, - { - "category": "Interest", - "offset": 601, - "length": 2 - } - ], - "regionOffset": 0, - "regionLength": 1793 - } - ] - } - } - ], - "nextLink": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/models/model2/evaluation/result/?api-version={api-version}&top=2147483645&skip={maxpagesize}&maxpagesize={maxpagesize}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json deleted file mode 100644 index ec29e204adea..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json +++ /dev/null @@ -1,232 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model2" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "projectKind": "CustomEntityRecognition", - "customEntityRecognitionEvaluation": { - "confusionMatrix": { - "BorrowerAddress": { - "BorrowerAddress": { - "normalizedValue": 86.206894, - "rawValue": 3.4482758 - }, - "$none": { - "normalizedValue": 13.793103, - "rawValue": 0.55172414 - } - }, - "BorrowerCity": { - "BorrowerCity": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "BorrowerName": { - "BorrowerName": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "BorrowerState": { - "BorrowerState": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "Date": { - "Date": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "Interest": { - "Interest": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LenderAddress": { - "LenderAddress": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LenderCity": { - "LenderCity": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LenderName": { - "LenderName": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LenderState": { - "LenderState": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LoanAmountNumbers": { - "LoanAmountNumbers": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LoanAmountWords": { - "LoanAmountWords": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "$none": { - "$none": { - "normalizedValue": 99.81485, - "rawValue": 51.90372 - }, - "BorrowerAddress": { - "normalizedValue": 0.18315019, - "rawValue": 0.0952381 - }, - "Interest": { - "normalizedValue": 0.002005294, - "rawValue": 0.0010427529 - } - } - }, - "entities": { - "Date": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "BorrowerName": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "BorrowerAddress": { - "f1": 0.6666666865348816, - "precision": 0.6000000238418579, - "recall": 0.75, - "truePositiveCount": 3, - "trueNegativeCount": 0, - "falsePositiveCount": 2, - "falseNegativeCount": 1 - }, - "BorrowerCity": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "BorrowerState": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LenderName": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LenderAddress": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LenderCity": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LenderState": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LoanAmountWords": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LoanAmountNumbers": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Interest": { - "f1": 0.75, - "precision": 0.75, - "recall": 0.75, - "truePositiveCount": 3, - "trueNegativeCount": 0, - "falsePositiveCount": 1, - "falseNegativeCount": 1 - } - }, - "microF1": 0.94845366, - "microPrecision": 0.93877554, - "microRecall": 0.9583333, - "macroF1": 0.9513889, - "macroPrecision": 0.9458334, - "macroRecall": 0.9583333 - }, - "evaluationOptions": { - "kind": "percentage", - "trainingSplitPercentage": 80, - "testingSplitPercentage": 20 - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetProject.json deleted file mode 100644 index d61f87f78224..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetProject.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json deleted file mode 100644 index 53e48a5724fa..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000", - "createdDateTime": "2022-04-18T14:02:34Z", - "lastUpdatedDateTime": "2022-04-18T14:02:34Z", - "expirationDateTime": "2022-04-25T14:02:34Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json deleted file mode 100644 index 6b74ced2bee8..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json +++ /dev/null @@ -1,389 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "languageName": "English", - "languageCode": "en" - }, - { - "languageName": "English", - "languageCode": "en-us" - }, - { - "languageName": "French", - "languageCode": "fr" - }, - { - "languageName": "Italian", - "languageCode": "it" - }, - { - "languageName": "Spanish", - "languageCode": "es" - }, - { - "languageName": "German", - "languageCode": "de" - }, - { - "languageName": "Portuguese (Brazil)", - "languageCode": "pt-br" - }, - { - "languageName": "Portuguese (Portugal)", - "languageCode": "pt-pt" - }, - { - "languageName": "Afrikaans", - "languageCode": "af" - }, - { - "languageName": "Amharic", - "languageCode": "am" - }, - { - "languageName": "Arabic", - "languageCode": "ar" - }, - { - "languageName": "Assamese", - "languageCode": "as" - }, - { - "languageName": "Azerbaijani", - "languageCode": "az" - }, - { - "languageName": "Belarusian", - "languageCode": "be" - }, - { - "languageName": "Bulgarian", - "languageCode": "bg" - }, - { - "languageName": "Breton", - "languageCode": "br" - }, - { - "languageName": "Bosnian", - "languageCode": "bs" - }, - { - "languageName": "Catalan", - "languageCode": "ca" - }, - { - "languageName": "Czech", - "languageCode": "cs" - }, - { - "languageName": "Welsh", - "languageCode": "cy" - }, - { - "languageName": "Danish", - "languageCode": "da" - }, - { - "languageName": "Greek", - "languageCode": "el" - }, - { - "languageName": "Esperanto", - "languageCode": "eo" - }, - { - "languageName": "Estonian", - "languageCode": "et" - }, - { - "languageName": "Basque", - "languageCode": "eu" - }, - { - "languageName": "Persian", - "languageCode": "fa" - }, - { - "languageName": "Finnish", - "languageCode": "fi" - }, - { - "languageName": "Western Frisian", - "languageCode": "fy" - }, - { - "languageName": "Irish", - "languageCode": "ga" - }, - { - "languageName": "Scottish Gaelic", - "languageCode": "gd" - }, - { - "languageName": "Galician", - "languageCode": "gl" - }, - { - "languageName": "Gujarati", - "languageCode": "gu" - }, - { - "languageName": "Hausa", - "languageCode": "ha" - }, - { - "languageName": "Hebrew", - "languageCode": "he" - }, - { - "languageName": "Hindi", - "languageCode": "hi" - }, - { - "languageName": "Croatian", - "languageCode": "hr" - }, - { - "languageName": "Hungarian", - "languageCode": "hu" - }, - { - "languageName": "Armenian", - "languageCode": "hy" - }, - { - "languageName": "Indonesian", - "languageCode": "id" - }, - { - "languageName": "Japanese", - "languageCode": "ja" - }, - { - "languageName": "Javanese", - "languageCode": "jv" - }, - { - "languageName": "Georgian", - "languageCode": "ka" - }, - { - "languageName": "Kazakh", - "languageCode": "kk" - }, - { - "languageName": "Khmer", - "languageCode": "km" - }, - { - "languageName": "Kannada", - "languageCode": "kn" - }, - { - "languageName": "Korean", - "languageCode": "ko" - }, - { - "languageName": "Kurdish (Kurmanji)", - "languageCode": "ku" - }, - { - "languageName": "Kyrgyz", - "languageCode": "ky" - }, - { - "languageName": "Latin", - "languageCode": "la" - }, - { - "languageName": "Lao", - "languageCode": "lo" - }, - { - "languageName": "Lithuanian", - "languageCode": "lt" - }, - { - "languageName": "Latvian", - "languageCode": "lv" - }, - { - "languageName": "Malagasy", - "languageCode": "mg" - }, - { - "languageName": "Macedonian", - "languageCode": "mk" - }, - { - "languageName": "Malayalam", - "languageCode": "ml" - }, - { - "languageName": "Mongolian", - "languageCode": "mn" - }, - { - "languageName": "Marathi", - "languageCode": "mr" - }, - { - "languageName": "Malay", - "languageCode": "ms" - }, - { - "languageName": "Burmese", - "languageCode": "my" - }, - { - "languageName": "Nepali", - "languageCode": "ne" - }, - { - "languageName": "Dutch", - "languageCode": "nl" - }, - { - "languageName": "Norwegian (Bokmal)", - "languageCode": "nb" - }, - { - "languageName": "Odia", - "languageCode": "or" - }, - { - "languageName": "Punjabi", - "languageCode": "pa" - }, - { - "languageName": "Polish", - "languageCode": "pl" - }, - { - "languageName": "Pashto", - "languageCode": "ps" - }, - { - "languageName": "Romanian", - "languageCode": "ro" - }, - { - "languageName": "Russian", - "languageCode": "ru" - }, - { - "languageName": "Sanskrit", - "languageCode": "sa" - }, - { - "languageName": "Sindhi", - "languageCode": "sd" - }, - { - "languageName": "Sinhala", - "languageCode": "si" - }, - { - "languageName": "Slovak", - "languageCode": "sk" - }, - { - "languageName": "Slovenian", - "languageCode": "sl" - }, - { - "languageName": "Somali", - "languageCode": "so" - }, - { - "languageName": "Albanian", - "languageCode": "sq" - }, - { - "languageName": "Serbian", - "languageCode": "sr" - }, - { - "languageName": "Sundanese", - "languageCode": "su" - }, - { - "languageName": "Swedish", - "languageCode": "sv" - }, - { - "languageName": "Swahili", - "languageCode": "sw" - }, - { - "languageName": "Tamil", - "languageCode": "ta" - }, - { - "languageName": "Telugu", - "languageCode": "te" - }, - { - "languageName": "Thai", - "languageCode": "th" - }, - { - "languageName": "Filipino", - "languageCode": "tl" - }, - { - "languageName": "Turkish", - "languageCode": "tr" - }, - { - "languageName": "Uyghur", - "languageCode": "ug" - }, - { - "languageName": "Ukrainian", - "languageCode": "uk" - }, - { - "languageName": "Urdu", - "languageCode": "ur" - }, - { - "languageName": "Uzbek", - "languageCode": "uz" - }, - { - "languageName": "Vietnamese", - "languageCode": "vi" - }, - { - "languageName": "Xhosa", - "languageCode": "xh" - }, - { - "languageName": "Yiddish", - "languageCode": "yi" - }, - { - "languageName": "Chinese (Simplified)", - "languageCode": "zh-hans" - }, - { - "languageName": "Chinese (Traditional)", - "languageCode": "zh-hant" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json deleted file mode 100644 index 0202e9674355..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectKind": "CustomEntityRecognition" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "trainingConfigVersion": "2022-05-01", - "modelExpirationDate": "2022-10-28" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json deleted file mode 100644 index f0042dae47be..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", - "createdDateTime": "2022-04-18T16:09:50Z", - "lastUpdatedDateTime": "2022-04-18T16:09:58Z", - "expirationDateTime": "2022-04-25T16:09:50Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json deleted file mode 100644 index 60ea423697ca..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "result": { - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", - "trainingStatus": { - "percentComplete": 3, - "startDateTime": "2022-04-18T15:45:06.8190649Z", - "status": "running" - }, - "evaluationStatus": { - "percentComplete": 0, - "status": "notStarted" - } - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:45:48Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "running" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulImportProject.json deleted file mode 100644 index 0554ad9bd3f2..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulImportProject.json +++ /dev/null @@ -1,99 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "body": { - "projectFileVersion": "2022-05-01", - "stringIndexType": "Utf16CodeUnit", - "metadata": { - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "settings": {}, - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - }, - "assets": { - "projectKind": "CustomEntityRecognition", - "entities": [ - { - "category": "Date" - }, - { - "category": "LenderName" - }, - { - "category": "LenderAddress" - } - ], - "documents": [ - { - "location": "01.txt", - "language": "en-us", - "entities": [ - { - "regionOffset": 0, - "regionLength": 1793, - "labels": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "LenderName", - "offset": 273, - "length": 14 - }, - { - "category": "LenderAddress", - "offset": 314, - "length": 15 - } - ] - } - ] - }, - { - "location": "02.txt", - "language": "en-us", - "entities": [ - { - "regionOffset": 0, - "regionLength": 1804, - "labels": [ - { - "category": "Date", - "offset": 5, - "length": 10 - }, - { - "category": "LenderName", - "offset": 284, - "length": 10 - }, - { - "category": "LenderAddress", - "offset": 321, - "length": 20 - } - ] - } - ] - } - ] - } - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulListDeployments.json deleted file mode 100644 index 53183fbdb9c0..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulListDeployments.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "deploymentName": "production", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T16:03:51Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01" - }, - { - "deploymentName": "staging", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T15:53:04Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulListModels.json deleted file mode 100644 index a6ac22fdbbe0..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulListModels.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "label": "model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49Z", - "lastTrainingDurationInSeconds": 186, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01" - }, - { - "label": "model2", - "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", - "lastTrainedDateTime": "2022-04-18T17:25:22Z", - "lastTrainingDurationInSeconds": 192, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulListProjects.json deleted file mode 100644 index b57d035b9e44..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulListProjects.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - }, - { - "createdDateTime": "2022-04-18T14:03:12Z", - "lastModifiedDateTime": "2022-04-18T14:03:12Z", - "projectKind": "CustomMultiLabelClassification", - "storageInputContainerName": "loanagreements", - "projectName": "MoviesSummary", - "multilingual": false, - "description": "This is a sample dataset adapted from the CMU Movie Summary public dataset. This was prepared by Microsoft Azure Language Services product team to prepare this dataset to be used as a sample for getting started with Custom text classification. This sample dataset consists of 210 files each of them is a movie summary. Each movie can be classified into one or more of the following classes: \"Mystery\", \"Drama\", \"Thriller\", \"Comedy\", \"Action\".", - "language": "en" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json deleted file mode 100644 index 283deeb5b122..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json +++ /dev/null @@ -1,87 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "result": { - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T15:45:06.8190649Z", - "endDateTime": "2022-04-18T15:47:19.2639682Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T15:47:19.2734976Z", - "endDateTime": "2022-04-18T15:47:23.8378892Z", - "status": "succeeded" - } - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:47:50Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "succeeded" - }, - { - "result": { - "modelLabel": "model2", - "trainingConfigVersion": "2022-05-01", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:22:39.3663023Z", - "endDateTime": "2022-04-18T17:24:51.9440947Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:24:51.9571747Z", - "endDateTime": "2022-04-18T17:24:58.1427823Z", - "status": "succeeded" - } - }, - "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", - "createdDateTime": "2022-04-18T17:22:11Z", - "lastUpdatedDateTime": "2022-04-18T17:25:23Z", - "expirationDateTime": "2022-04-25T17:22:11Z", - "status": "succeeded" - }, - { - "result": { - "modelLabel": "model2", - "trainingConfigVersion": "2022-05-01", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:44:41.388358Z", - "endDateTime": "2022-04-18T17:50:29.5675101Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:50:29.5808461Z", - "endDateTime": "2022-04-18T17:50:35.3482185Z", - "status": "succeeded" - } - }, - "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", - "createdDateTime": "2022-04-18T17:44:04Z", - "lastUpdatedDateTime": "2022-04-18T17:51:11Z", - "expirationDateTime": "2022-04-25T17:44:04Z", - "status": "succeeded" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulSwapDeployments.json deleted file mode 100644 index 10bc98582dc4..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulSwapDeployments.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "body": { - "firstDeploymentName": "production", - "secondDeploymentName": "staging" - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulTrainProject.json deleted file mode 100644 index a945abe7809c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/analyzetext-authoring/SuccessfulTrainProject.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "projectName": "LoanAgreements", - "body": { - "modelLabel": "model1", - "trainingConfigVersion": "latest", - "evaluationOptions": { - "kind": "percentage", - "testingSplitPercentage": 20, - "trainingSplitPercentage": 80 - } - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulAnalyzeConversations.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulAnalyzeConversations.json deleted file mode 100644 index 65d7e5e59079..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulAnalyzeConversations.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "id": "1", - "participantId": "1", - "text": "play In the air tonight from Phil Collins" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "play In the air tonight from Phil Collins", - "prediction": { - "topIntent": "PlayMusic", - "projectKind": "Conversation", - "intents": [ - { - "category": "PlayMusic", - "confidenceScore": 1 - }, - { - "category": "SearchCreativeWork", - "confidenceScore": 0 - }, - { - "category": "AddToPlaylist", - "confidenceScore": 0 - } - ], - "entities": [ - { - "category": "Media.Artist", - "text": "Phil Collins", - "offset": 29, - "length": 12, - "confidenceScore": 1 - } - ] - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json deleted file mode 100644 index 7554c0ff33da..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "participantId": "1", - "id": "1", - "modality": "text", - "language": "en-GB", - "text": "How do I integrate QnA Maker and LUIS?" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "verbose": true, - "isLoggingEnabled": false, - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Rail", - "projectKind": "Orchestration", - "intents": { - "Rail": { - "confidenceScore": 1, - "targetProjectKind": "Conversation", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Timetable", - "projectKind": "Conversation", - "intents": [ - { - "category": "Timetable", - "confidenceScore": 0.99968535 - }, - { - "category": "Locomotive", - "confidenceScore": 0.000314623 - } - ], - "entities": [] - } - } - }, - "Tree": { - "confidenceScore": 0.2641529, - "targetProjectKind": "QuestionAnswering" - }, - "None": { - "confidenceScore": 0, - "targetProjectKind": "NonLinked" - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json deleted file mode 100644 index a3a408f73a9a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "text": "Ports and connectors", - "participantId": "1", - "id": "1" - } - }, - "parameters": { - "projectName": "prj1", - "deploymentName": "dep1", - "directTarget": "qnaProject", - "targetProjectParameters": { - "qnaProject": { - "targetProjectKind": "QuestionAnswering", - "callingOptions": { - "context": { - "previousUserQuery": "Meet Surface Pro 4", - "previousQnaId": 4 - }, - "top": 1, - "question": "App Service overview" - } - } - } - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "Ports and connectors", - "prediction": { - "projectKind": "Orchestration", - "topIntent": "qnaTargetApp", - "intents": { - "qnaTargetApp": { - "targetProjectKind": "QuestionAnswering", - "confidenceScore": 1, - "result": { - "answers": [ - { - "questions": [ - "App Service overview" - ], - "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.", - "confidenceScore": 0.7384000000000001, - "id": 1, - "source": "https://docs.microsoft.com/en-us/azure/app-service/overview", - "metadata": {}, - "dialog": { - "isContextOnly": false, - "prompts": [] - } - } - ] - } - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json deleted file mode 100644 index 484ae8102bfb..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversations/jobs/{jobId}?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulConversationPIISubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulConversationPIISubmit.json deleted file mode 100644 index 11e7ae14947a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulConversationPIISubmit.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "audioTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "piiCategories": [ - "All" - ], - "redactionSource": "lexical", - "includeAudioRedaction": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulConversationPIITaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulConversationPIITaskStatusRequest.json deleted file mode 100644 index 86ce4b5820b4..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulConversationPIITaskStatusRequest.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "ConversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning *************.", - "itn": "good morning *************", - "maskedItn": "good morning *************", - "lexical": "good morning *************", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [ - { - "category": "Name", - "confidenceScore": 0.91, - "length": 8, - "offset": 13, - "text": "john doe" - } - ] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json deleted file mode 100644 index a645ab67be02..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Analyze chat", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "ConversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "analyze 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "20220101meeting", - "summaries": [ - { - "aspect": "issue", - "text": "Customer wants to cancel his subscription. Customer doesn't know how" - }, - { - "aspect": "resolution", - "text": "pii Auto-Fortify. \npii Gamertag.\npii E-mail.\nCanceled customer's subscription" - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulConversationSummarySubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulConversationSummarySubmit.json deleted file mode 100644 index 9408aa272f05..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/conversations/SuccessfulConversationSummarySubmit.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Analyze conversations from Contoso meeting", - "analysisInput": { - "conversations": [ - { - "id": "20220101meeting", - "language": "en", - "modality": "text", - "domain": "generic", - "conversationItems": [ - { - "participantId": "user", - "role": "customer", - "id": "1", - "text": "Hi!" - }, - { - "participantId": "agent", - "role": "agent", - "id": "2", - "text": "Hello, how can I help you?" - }, - { - "participantId": "user", - "role": "customer", - "id": "3", - "text": "I am having trouble issuing a return of a game on my xbox: call of duty" - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "analyze 1", - "kind": "ConversationalSummarizationTask", - "parameters": { - "modelVersion": "latest", - "summaryAspects": [ - "issue", - "resolution" - ] - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json deleted file mode 100644 index 6e4c04cc6a92..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json +++ /dev/null @@ -1,99 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1", - "deploymentName": "production", - "knowledgeBaseQueryOptions": { - "question": "how long it takes to charge surface?", - "top": 3, - "userId": "sd53lsY=", - "confidenceScoreThreshold": 0.20, - "context": { - "previousQnaId": 9, - "previousUserQuery": "Where are QnA Maker quickstarts?" - }, - "rankerType": "Default", - "filters": { - "metadataFilter": { - "metadata": [ - { - "key": "category", - "value": "api" - }, - { - "key": "editorial", - "value": "chitchat" - } - ], - "logicalOperation": "AND" - }, - "sourceFilter": [ - "filename1.pdf", - "https://www.wikipedia.org/microsoft" - ], - "logicalOperation": "AND" - }, - "answerSpanRequest": { - "enable": true, - "confidenceScoreThreshold": 0.20, - "topAnswersWithSpan": 1 - }, - "includeUnstructuredSources": true - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "answers": [ - { - "questions": [ - "Power and charging" - ], - "answer": "Power and charging**\n\nIt takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.\n\nYou can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface.", - "confidenceScore": 0.65, - "id": 20, - "source": "surface-pro-4-user-guide-EN.pdf", - "metadata": { - "category": "api", - "editorial": "chitchat" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 23, - "displayText": "prompt1" - }, - { - "displayOrder": 2, - "qnaId": 36, - "displayText": "prompt2" - } - ] - }, - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0.30, - "offset": 33, - "length": 50 - } - }, - { - "questions": [ - "Charge your Surface Pro 4" - ], - "answer": "**Charge your Surface Pro 4**\n\n1. Connect the two parts of the power cord.\n\n2. Connect the power cord securely to the charging port.\n\n3. Plug the power supply into an electrical outlet.", - "confidenceScore": 0.32, - "id": 13, - "source": "surface-pro-4-user-guide-EN.pdf" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/SuccessfulQueryText.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/SuccessfulQueryText.json deleted file mode 100644 index 7d84cfe2ec9a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/SuccessfulQueryText.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "stringIndexType": "TextElements_v8", - "textQueryOptions": { - "question": "how long it takes to charge surface?", - "records": [ - { - "id": "1", - "text": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it." - }, - { - "id": "2", - "text": "You can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface." - } - ], - "language": "en" - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "answers": [ - { - "answer": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", - "confidenceScore": 0.93, - "id": "1", - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0, - "offset": 28, - "length": 45 - }, - "offset": 0, - "length": 224 - }, - { - "answer": "It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", - "confidenceScore": 0.92, - "id": "1", - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0, - "offset": 8, - "length": 25 - }, - "offset": 20, - "length": 224 - }, - { - "answer": "It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", - "confidenceScore": 0.05, - "id": "1", - "answerSpan": null, - "offset": 110, - "length": 244 - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json deleted file mode 100644 index 027a1b6b8706..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1", - "body": { - "description": "proj1 is a test project.", - "language": "en", - "settings": { - "defaultAnswer": "No good match found for your question in the Knowledgebase." - }, - "multilingualResource": true - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "settings": { - "defaultAnswer": "No good match found for your question in the Knowledgebase." - }, - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - }, - "201": { - "headers": {}, - "body": { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "settings": { - "defaultAnswer": "No good match found for your question in the Knowledgebase." - }, - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json deleted file mode 100644 index 24e8c52517e0..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1" - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/deletion-jobs/job1?api-version=2022-07-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulGetProject.json deleted file mode 100644 index 415083f4fda7..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulGetProject.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "settings": { - "defaultAnswer": "No good match found for your question in the Knowledgebase." - }, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json deleted file mode 100644 index 66ed29d2ec66..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": 1, - "answer": "ans1", - "source": "source1", - "questions": [ - "question 1.1", - "question 1.2" - ], - "metadata": { - "k1": "v1", - "k2": "v2" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 11, - "displayText": "prompt 1.1" - }, - { - "displayOrder": 2, - "qnaId": 21, - "displayText": "prompt 1.2" - } - ] - }, - "lastUpdatedDateTime": "2021-05-01T17:21:14Z" - }, - { - "id": 2, - "answer": "ans2", - "source": "source2", - "questions": [ - "question 2.1", - "question 2.2" - ], - "lastUpdatedDateTime": "2021-05-01T17:21:14Z" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulGetSources.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulGetSources.json deleted file mode 100644 index 2422206550b6..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulGetSources.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "displayName": "source1", - "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview", - "sourceKind": "url", - "lastUpdatedDateTime": "2021-05-01T15:13:22Z", - "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview" - }, - { - "displayName": "source2", - "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf", - "sourceKind": "file", - "contentStructureKind": "unstructured", - "lastUpdatedDateTime": "2021-05-01T15:13:22Z", - "source": "surface-guide.pdf" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json deleted file mode 100644 index febc33da4081..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "alterations": [ - "qnamaker", - "qna maker" - ] - }, - { - "alterations": [ - "botframework", - "bot framework" - ] - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json deleted file mode 100644 index 44d16cedc4de..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json deleted file mode 100644 index f27b0f5652e7..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1", - "deploymentName": "production", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json deleted file mode 100644 index cd9f4c549ff7..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded", - "resultUrl": "https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2022-07-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json deleted file mode 100644 index 51f1a88e5fea..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json deleted file mode 100644 index a4776d6c2695..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "deploymentName": "production", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json deleted file mode 100644 index 9f43678e0b93..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1", - "deploymentName": "production" - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/deployments/production/jobs/job1?api-version=2022-07-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json deleted file mode 100644 index 616abdca97ee..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1", - "body": { - "exportAssetTypes": [ - "qnas", - "synonyms" - ] - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded", - "resultUrl": "https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2022-07-01-preview" - } - }, - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2022-07-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json deleted file mode 100644 index 6a15421fb217..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json +++ /dev/null @@ -1,73 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1", - "body": { - "assets": { - "synonyms": [ - { - "alterations": [ - "wa", - "washington", - "washington state" - ] - }, - { - "alterations": [ - "U.S", - "usa", - "united states of america" - ] - } - ], - "qnas": [ - { - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "id": 1, - "answer": "ans1", - "source": "source1", - "questions": [ - "question 1.1", - "question 1.2" - ], - "metadata": { - "k1": "v1", - "k2": "v2" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 2, - "displayText": "prompt 1.1" - } - ] - } - }, - { - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "id": 2, - "answer": "ans2", - "source": "source2", - "questions": [ - "question 2.1", - "question 2.2" - ] - } - ] - } - } - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/import/jobs/job1?api-version=2022-07-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json deleted file mode 100644 index 3cd1a9806d39..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - }, - { - "projectName": "proj2", - "description": "proj2 is a test project.", - "language": "fr", - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json deleted file mode 100644 index 77e40e7b10e0..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1", - "body": { - "records": [ - { - "userId": "user1", - "userQuestion": "hi", - "qnaId": 1 - }, - { - "userId": "user1", - "userQuestion": "hello", - "qnaId": 2 - } - ] - } - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json deleted file mode 100644 index 76287b2bf5f1..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1", - "body": [ - { - "op": "add", - "value": { - "id": 3, - "answer": "ans3", - "source": "source1", - "questions": [ - "question 3.1", - "question 3.2" - ], - "metadata": { - "k1": "v1", - "k2": "v2" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 11, - "displayText": "prompt 3.1" - }, - { - "displayOrder": 2, - "qnaId": 21, - "displayText": "prompt 3.2" - } - ] - } - } - }, - { - "op": "replace", - "value": { - "id": 1, - "answer": "ans4", - "source": "source1", - "questions": [ - "question 4.1", - "question 4.2" - ] - } - }, - { - "op": "delete", - "value": { - "id": 2, - "answer": "ans2", - "source": "source1", - "questions": [ - "question 2.1", - "question 2.2" - ] - } - } - ] - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/qnas/jobs/job1?api-version=2022-07-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json deleted file mode 100644 index 51f1a88e5fea..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json deleted file mode 100644 index d2104b728381..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1", - "body": [ - { - "op": "add", - "value": { - "displayName": "source3", - "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context", - "sourceKind": "url", - "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context" - } - }, - { - "op": "replace", - "value": { - "displayName": "source1", - "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview", - "sourceKind": "url", - "refresh": true, - "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview" - } - }, - { - "op": "delete", - "value": { - "displayName": "source2", - "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf", - "sourceKind": "file", - "source": "surface-guide.pdf" - } - } - ] - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/sources/jobs/job1?api-version=2022-07-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json deleted file mode 100644 index 51f1a88e5fea..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json deleted file mode 100644 index 1455b0510223..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-07-01-preview", - "projectName": "proj1", - "body": { - "value": [ - { - "alterations": [ - "qnamaker", - "qna maker" - ] - }, - { - "alterations": [ - "botframework", - "bot framework" - ] - } - ] - } - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulAnalyzeTextJobsCancelRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulAnalyzeTextJobsCancelRequest.json deleted file mode 100644 index 29220d9fd3e2..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulAnalyzeTextJobsCancelRequest.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json deleted file mode 100644 index 6320a2858cd8..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json +++ /dev/null @@ -1,131 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Extracting Location & US Region", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 2, - "failed": 0, - "inProgress": 0, - "total": 2, - "items": [ - { - "kind": "EntityRecognitionLROResults", - "taskName": "Recognize Entities", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "entities": [ - { - "category": "Event", - "confidenceScore": 0.61, - "length": 4, - "offset": 18, - "text": "trip" - }, - { - "category": "Location", - "confidenceScore": 0.82, - "length": 7, - "offset": 26, - "subcategory": "GPE", - "text": "Seattle" - }, - { - "category": "DateTime", - "confidenceScore": 0.8, - "length": 9, - "offset": 34, - "subcategory": "DateRange", - "text": "last week" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "Location", - "confidenceScore": 0.52, - "length": 3, - "offset": 14, - "subcategory": "GPE", - "text": "NYC" - }, - { - "category": "DateTime", - "confidenceScore": 0.8, - "length": 8, - "offset": 18, - "subcategory": "Date", - "text": "tomorrow" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-04-01" - } - }, - { - "kind": "CustomEntityRecognitionLROResults", - "taskName": "Recognize US Regions", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "entities": [ - { - "category": "USRegion", - "confidenceScore": 0.85, - "length": 17, - "offset": 45, - "text": "Pacific Northwest" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "USRegion", - "confidenceScore": 0.88, - "length": 10, - "offset": 63, - "text": "East Coast" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "projectName": "MyProject", - "deploymentName": "MyDeployment" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json deleted file mode 100644 index 2077d5997456..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Extracting Location & US Region", - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "I had a wonderful trip to Seattle last week." - }, - { - "id": "2", - "language": "en", - "text": "I'm flying to NYC tomorrow. See you there." - } - ] - }, - "tasks": [ - { - "kind": "EntityRecognition", - "taskName": "Recognize Entities", - "parameters": { - "modelVersion": "latest" - } - }, - { - "kind": "CustomEntityRecognition", - "taskName": "Recognize US Regions", - "parameters": { - "projectName": "MyProject", - "deploymentName": "MyDeployment" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulEntityLinkingRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulEntityLinkingRequest.json deleted file mode 100644 index c67919cf2cff..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulEntityLinkingRequest.json +++ /dev/null @@ -1,128 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "EntityLinking", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Microsoft was founded by Bill Gates and Paul Allen." - }, - { - "id": "2", - "language": "en", - "text": "Pike place market is my favorite Seattle attraction." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "EntityLinkingResults", - "results": { - "documents": [ - { - "entities": [ - { - "dataSource": "Wikipedia", - "id": "Bill Gates", - "language": "en", - "matches": [ - { - "confidenceScore": 0.52, - "length": 10, - "offset": 25, - "text": "Bill Gates" - } - ], - "name": "Bill Gates", - "url": "https://en.wikipedia.org/wiki/Bill_Gates" - }, - { - "dataSource": "Wikipedia", - "id": "Paul Allen", - "language": "en", - "matches": [ - { - "confidenceScore": 0.54, - "length": 10, - "offset": 40, - "text": "Paul Allen" - } - ], - "name": "Paul Allen", - "url": "https://en.wikipedia.org/wiki/Paul_Allen" - }, - { - "dataSource": "Wikipedia", - "id": "Microsoft", - "language": "en", - "matches": [ - { - "confidenceScore": 0.49, - "length": 9, - "offset": 0, - "text": "Microsoft" - } - ], - "name": "Microsoft", - "url": "https://en.wikipedia.org/wiki/Microsoft" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "dataSource": "Wikipedia", - "id": "Pike Place Market", - "language": "en", - "matches": [ - { - "confidenceScore": 0.86, - "length": 17, - "offset": 0, - "text": "Pike place market" - } - ], - "name": "Pike Place Market", - "url": "https://en.wikipedia.org/wiki/Pike_Place_Market" - }, - { - "dataSource": "Wikipedia", - "id": "Seattle", - "language": "en", - "matches": [ - { - "confidenceScore": 0.27, - "length": 7, - "offset": 33, - "text": "Seattle" - } - ], - "name": "Seattle", - "url": "https://en.wikipedia.org/wiki/Seattle" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-02-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulEntityRecognitionRequest.json deleted file mode 100644 index 166686751a03..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulEntityRecognitionRequest.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "EntityRecognition", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Microsoft was founded by Bill Gates and Paul Allen." - }, - { - "id": "2", - "language": "en", - "text": "Pike place market is my favorite Seattle attraction." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "EntityRecognitionResults", - "results": { - "documents": [ - { - "entities": [ - { - "category": "Organization", - "confidenceScore": 0.84, - "length": 9, - "offset": 0, - "text": "Microsoft" - }, - { - "category": "Person", - "confidenceScore": 0.85, - "length": 10, - "offset": 25, - "text": "Bill Gates" - }, - { - "category": "Person", - "confidenceScore": 0.9, - "length": 10, - "offset": 40, - "text": "Paul Allen" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "Location", - "confidenceScore": 0.55, - "length": 7, - "offset": 33, - "subcategory": "GPE", - "text": "Seattle" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-06-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulHealthcarePostRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulHealthcarePostRequest.json deleted file mode 100644 index e43dd063fb2a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulHealthcarePostRequest.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "analysisInput": { - "documents": [ - { - "text": "Prescribed 100mg ibuprofen, taken twice daily.", - "id": "1", - "language": "en" - } - ] - }, - "tasks": [ - { - "kind": "Healthcare", - "parameters": { - "modelVersion": "latest" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version={api-version}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulHealthcareTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulHealthcareTaskStatusRequest.json deleted file mode 100644 index 9b2118f9571d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulHealthcareTaskStatusRequest.json +++ /dev/null @@ -1,220 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-07-20T18:43:35Z", - "displayName": "Extracting Location & US Region", - "expirationDateTime": "2022-07-21T18:43:35Z", - "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0", - "lastUpdatedDateTime": "2022-07-20T18:43:36Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "HealthcareLROResults", - "lastUpdateDateTime": "2022-07-20T18:43:36.7159045Z", - "status": "succeeded", - "results": { - "documents": [ - { - "id": "1", - "entities": [ - { - "offset": 11, - "length": 5, - "text": "100mg", - "category": "Dosage", - "confidenceScore": 0.98 - }, - { - "offset": 17, - "length": 9, - "text": "ibuprofen", - "category": "MedicationName", - "confidenceScore": 1, - "name": "ibuprofen", - "links": [ - { - "dataSource": "UMLS", - "id": "C0020740" - }, - { - "dataSource": "AOD", - "id": "0000019879" - }, - { - "dataSource": "ATC", - "id": "M01AE01" - }, - { - "dataSource": "CCPSS", - "id": "0046165" - }, - { - "dataSource": "CHV", - "id": "0000006519" - }, - { - "dataSource": "CSP", - "id": "2270-2077" - }, - { - "dataSource": "DRUGBANK", - "id": "DB01050" - }, - { - "dataSource": "GS", - "id": "1611" - }, - { - "dataSource": "LCH_NW", - "id": "sh97005926" - }, - { - "dataSource": "LNC", - "id": "LP16165-0" - }, - { - "dataSource": "MEDCIN", - "id": "40458" - }, - { - "dataSource": "MMSL", - "id": "d00015" - }, - { - "dataSource": "MSH", - "id": "D007052" - }, - { - "dataSource": "MTHSPL", - "id": "WK2XYI10QM" - }, - { - "dataSource": "NCI", - "id": "C561" - }, - { - "dataSource": "NCI_CTRP", - "id": "C561" - }, - { - "dataSource": "NCI_DCP", - "id": "00803" - }, - { - "dataSource": "NCI_DTP", - "id": "NSC0256857" - }, - { - "dataSource": "NCI_FDA", - "id": "WK2XYI10QM" - }, - { - "dataSource": "NCI_NCI-GLOSS", - "id": "CDR0000613511" - }, - { - "dataSource": "NDDF", - "id": "002377" - }, - { - "dataSource": "PDQ", - "id": "CDR0000040475" - }, - { - "dataSource": "RCD", - "id": "x02MO" - }, - { - "dataSource": "RXNORM", - "id": "5640" - }, - { - "dataSource": "SNM", - "id": "E-7772" - }, - { - "dataSource": "SNMI", - "id": "C-603C0" - }, - { - "dataSource": "SNOMEDCT_US", - "id": "387207008" - }, - { - "dataSource": "USP", - "id": "m39860" - }, - { - "dataSource": "USPMG", - "id": "MTHU000060" - }, - { - "dataSource": "VANDF", - "id": "4017840" - } - ] - }, - { - "offset": 34, - "length": 11, - "text": "twice daily", - "category": "Frequency", - "confidenceScore": 1 - } - ], - "relations": [ - { - "confidenceScore": 1, - "relationType": "DosageOfMedication", - "entities": [ - { - "ref": "#/results/documents/0/entities/0", - "role": "Dosage" - }, - { - "ref": "#/results/documents/0/entities/1", - "role": "Medication" - } - ] - }, - { - "confidenceScore": 1, - "relationType": "FrequencyOfMedication", - "entities": [ - { - "ref": "#/results/documents/0/entities/1", - "role": "Medication" - }, - { - "ref": "#/results/documents/0/entities/2", - "role": "Frequency" - } - ] - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2022-03-01" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulKeyPhraseExtractionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulKeyPhraseExtractionRequest.json deleted file mode 100644 index 4ca1175fdcf5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulKeyPhraseExtractionRequest.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "KeyPhraseExtraction", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Microsoft was founded by Bill Gates and Paul Allen." - }, - { - "id": "2", - "language": "en", - "text": "Text Analytics is one of the Azure Cognitive Services." - }, - { - "id": "3", - "language": "en", - "text": "My cat might need to see a veterinarian." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "KeyPhraseExtractionResults", - "results": { - "documents": [ - { - "id": "1", - "keyPhrases": [ - "Bill Gates", - "Paul Allen", - "Microsoft" - ], - "warnings": [] - }, - { - "id": "2", - "keyPhrases": [ - "Azure Cognitive Services", - "Text Analytics" - ], - "warnings": [] - }, - { - "id": "3", - "keyPhrases": [ - "cat", - "veterinarian" - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-06-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulLanguageDetectionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulLanguageDetectionRequest.json deleted file mode 100644 index 9aea23cf3940..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulLanguageDetectionRequest.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "LanguageDetection", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "text": "Hello world" - }, - { - "id": "2", - "text": "Bonjour tout le monde" - }, - { - "id": "3", - "text": "Hola mundo" - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "LanguageDetectionResults", - "results": { - "documents": [ - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "en", - "name": "English" - }, - "id": "1", - "warnings": [] - }, - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "fr", - "name": "French" - }, - "id": "2", - "warnings": [] - }, - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "es", - "name": "Spanish" - }, - "id": "3", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-01-05" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulPiiEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulPiiEntityRecognitionRequest.json deleted file mode 100644 index b16ec3a7972b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulPiiEntityRecognitionRequest.json +++ /dev/null @@ -1,88 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "PiiEntityRecognition", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "My SSN is 859-98-0987" - }, - { - "id": "2", - "language": "en", - "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." - }, - { - "id": "3", - "language": "en", - "text": "Is 998.214.865-68 your Brazilian CPF number?" - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "PiiEntityRecognitionResults", - "results": { - "documents": [ - { - "id": "1", - "redactedText": "My SSN is ***********", - "entities": [ - { - "category": "U.S. Social Security Number (SSN)", - "confidenceScore": 0.65, - "length": 11, - "offset": 28, - "text": "859-98-0987" - } - ], - "warnings": [] - }, - { - "id": "2", - "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", - "entities": [ - { - "category": "ABA Routing Number", - "confidenceScore": 0.75, - "length": 9, - "offset": 18, - "text": "111000025" - } - ], - "warnings": [] - }, - { - "id": "3", - "redactedText": "Is ************** your Brazilian CPF number?", - "entities": [ - { - "category": "Brazil CPF Number", - "confidenceScore": 0.85, - "length": 14, - "offset": 3, - "text": "998.214.865-68" - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-01-15" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulSentimentAnalysisRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulSentimentAnalysisRequest.json deleted file mode 100644 index 06a04c2155f3..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/text/SuccessfulSentimentAnalysisRequest.json +++ /dev/null @@ -1,148 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-07-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "SentimentAnalysis", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "SentimentAnalysisResults", - "results": { - "documents": [ - { - "confidenceScores": { - "negative": 0, - "neutral": 0, - "positive": 1 - }, - "id": "1", - "sentences": [ - { - "targets": [ - { - "confidenceScores": { - "negative": 0, - "positive": 1 - }, - "length": 10, - "offset": 6, - "relations": [ - { - "ref": "#/documents/0/sentences/0/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "atmosphere" - } - ], - "confidenceScores": { - "negative": 0, - "neutral": 0, - "positive": 1 - }, - "length": 17, - "offset": 0, - "assessments": [ - { - "confidenceScores": { - "negative": 0, - "positive": 1 - }, - "isNegated": false, - "length": 5, - "offset": 0, - "sentiment": "positive", - "text": "great" - } - ], - "sentiment": "positive", - "text": "Great atmosphere." - }, - { - "targets": [ - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "length": 11, - "offset": 37, - "relations": [ - { - "ref": "#/documents/0/sentences/1/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "restaurants" - }, - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "length": 6, - "offset": 50, - "relations": [ - { - "ref": "#/documents/0/sentences/1/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "hotels" - } - ], - "confidenceScores": { - "negative": 0.01, - "neutral": 0.86, - "positive": 0.13 - }, - "length": 52, - "offset": 18, - "assessments": [ - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "isNegated": false, - "length": 15, - "offset": 18, - "sentiment": "positive", - "text": "Close to plenty" - } - ], - "sentiment": "neutral", - "text": "Close to plenty of restaurants, hotels, and transit!" - } - ], - "sentiment": "positive", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-10-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/questionanswering-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/questionanswering-authoring.json deleted file mode 100644 index 534082d62fed..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/questionanswering-authoring.json +++ /dev/null @@ -1,1803 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Question Answering - Authoring", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2022-07-01-preview" - }, - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" - } - }, - "apim_key": { - "type": "apiKey", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://cognitiveservices.azure.com/.default" - ] - }, - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language/authoring", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/query-knowledgebases/projects": { - "get": { - "summary": "Gets all projects for a user.", - "operationId": "QuestionAnsweringProjects_ListProjects", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "The metadata of all projects.", - "schema": { - "$ref": "#/definitions/ProjectsMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectsListProjects.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}": { - "get": { - "summary": "Get the requested project metadata.", - "operationId": "QuestionAnsweringProjects_GetProjectDetails", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The metadata for the specified project.", - "schema": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetProject.json" - } - } - }, - "patch": { - "summary": "Create or update a project.", - "operationId": "QuestionAnsweringProjects_CreateProject", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "description": "Parameters needed to create the project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CreateProjectOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The metadata of the updated project, if it already exists.", - "schema": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "201": { - "description": "The metadata of the created project, if it doesn't exist.", - "schema": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulCreateProject.json" - } - } - }, - "delete": { - "summary": "Delete the project.", - "operationId": "QuestionAnsweringProjects_DeleteProject", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulDeleteProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/deletion-jobs/{jobId}": { - "get": { - "summary": "Gets the status of a Project delete job.", - "operationId": "QuestionAnsweringProjects_GetDeleteStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Project delete job status.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/:export": { - "post": { - "summary": "Export project metadata and assets.", - "operationId": "QuestionAnsweringProjects_Export", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ImportExportFormatParameter" - }, - { - "$ref": "#/parameters/AssetKindParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Export job status, project metadata, and assets.", - "schema": { - "$ref": "#/definitions/ExportJobState" - } - }, - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/export/jobs/{jobId}": { - "get": { - "summary": "Gets the status of an Export job, once job completes, returns the project metadata, and assets.", - "operationId": "QuestionAnsweringProjects_GetExportStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Export job status, project metadata, and assets.", - "schema": { - "$ref": "#/definitions/ExportJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/:import": { - "post": { - "summary": "Import project assets.", - "operationId": "QuestionAnsweringProjects_Import", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Project assets the needs to be imported.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/ImportJobOptions" - } - }, - { - "$ref": "#/parameters/ImportExportFormatParameter" - }, - { - "$ref": "#/parameters/AssetKindParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/import/jobs/{jobId}": { - "get": { - "summary": "Gets the status of an Import job.", - "operationId": "QuestionAnsweringProjects_GetImportStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Import job status.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}": { - "put": { - "summary": "Deploy project to production.", - "operationId": "QuestionAnsweringProjects_DeployProject", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { - "get": { - "summary": "Gets the status of a Deploy job.", - "operationId": "QuestionAnsweringProjects_GetDeployStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Deploy job state.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/deployments": { - "get": { - "summary": "List all deployments of a project.", - "operationId": "QuestionAnsweringProjects_ListDeployments", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "List of deployments of a project.", - "schema": { - "$ref": "#/definitions/ProjectDeployments" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectListDeployments.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/synonyms": { - "get": { - "summary": "Gets all the synonyms of a project.", - "operationId": "QuestionAnsweringProjects_GetSynonyms", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "All the synonyms of a project.", - "schema": { - "$ref": "#/definitions/SynonymAssets" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetSynonyms.json" - } - } - }, - "put": { - "summary": "Updates all the synonyms of a project.", - "operationId": "QuestionAnsweringProjects_UpdateSynonyms", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "All the synonyms of a project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SynonymAssets" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "204": { - "description": "Synonyms update successfully." - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/sources": { - "get": { - "summary": "Gets all the sources of a project.", - "operationId": "QuestionAnsweringProjects_GetSources", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "All the sources of a project.", - "schema": { - "$ref": "#/definitions/QnaSources" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetSources.json" - } - } - }, - "patch": { - "summary": "Updates the sources of a project.", - "operationId": "QuestionAnsweringProjects_UpdateSources", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Update sources parameters of a project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateSourcesOptions" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSources.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/sources/jobs/{jobId}": { - "get": { - "summary": "Gets the status of update sources job.", - "operationId": "QuestionAnsweringProjects_GetUpdateSourcesStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Update sources job state.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/qnas": { - "get": { - "summary": "Gets all the QnAs of a project.", - "operationId": "QuestionAnsweringProjects_GetQnas", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SourceFilterParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "All the QnAs of a project.", - "schema": { - "$ref": "#/definitions/QnaAssets" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetQnas.json" - } - } - }, - "patch": { - "summary": "Updates the QnAs of a project.", - "operationId": "QuestionAnsweringProjects_UpdateQnas", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Update QnAs parameters of a project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateQnaOptions" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateQnas.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/qnas/jobs/{jobId}": { - "get": { - "summary": "Gets the status of update QnAs job.", - "operationId": "QuestionAnsweringProjects_GetUpdateQnasStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Update QnAs job state.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/feedback": { - "post": { - "summary": "Update Active Learning feedback.", - "operationId": "QuestionAnsweringProjects_AddFeedback", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Feedback for Active Learning.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ActiveLearningFeedback" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "204": { - "description": "Feedback recorded successfully." - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json" - } - } - } - } - }, - "definitions": { - "ActiveLearningFeedback": { - "type": "object", - "description": "Feedback for Active Learning.", - "additionalProperties": false, - "properties": { - "records": { - "$ref": "#/definitions/FeedbackRecords" - } - } - }, - "FeedbackRecords": { - "type": "array", - "description": "A list of Feedback Records for Active Learning.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/FeedbackRecord" - } - }, - "FeedbackRecord": { - "type": "object", - "description": "Feedback Record for Active Learning.", - "additionalProperties": false, - "properties": { - "userId": { - "type": "string", - "description": "Unique identifier of the user." - }, - "userQuestion": { - "type": "string", - "description": "User suggested question for the QnA." - }, - "qnaId": { - "type": "integer", - "description": "Unique ID of the QnA.", - "format": "int32" - } - } - }, - "ProjectsMetadata": { - "type": "object", - "description": "Collection of projects metadata and global settings.", - "additionalProperties": false, - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "nextLink": { - "type": "string" - } - } - }, - "ProjectMetadata": { - "type": "object", - "description": "Represents the project.", - "additionalProperties": false, - "properties": { - "projectName": { - "type": "string", - "description": "Name of the project." - }, - "description": { - "type": "string", - "description": "Description of the project." - }, - "language": { - "$ref": "common.json#/definitions/Language" - }, - "multilingualResource": { - "type": "boolean", - "description": "Resource enabled for multiple languages across projects or not." - }, - "settings": { - "$ref": "#/definitions/ProjectSettings" - }, - "createdDateTime": { - "type": "string", - "description": "Project creation date-time.", - "format": "date-time" - }, - "lastModifiedDateTime": { - "type": "string", - "description": "Represents the project last modified date-time.", - "format": "date-time" - }, - "lastDeployedDateTime": { - "type": "string", - "description": "Represents the project last deployment date-time.", - "format": "date-time" - } - } - }, - "CreateProjectOptions": { - "type": "object", - "description": "Parameters needed to create the project.", - "additionalProperties": false, - "required": [ - "language" - ], - "properties": { - "description": { - "type": "string", - "description": "Description of the project." - }, - "language": { - "$ref": "common.json#/definitions/Language" - }, - "multilingualResource": { - "type": "boolean", - "description": "Set to true to enable creating knowledgebases in different languages for the same resource." - }, - "settings": { - "$ref": "#/definitions/ProjectSettings" - } - } - }, - "ProjectSettings": { - "type": "object", - "description": "Configurable settings of the Project.", - "additionalProperties": false, - "properties": { - "defaultAnswer": { - "type": "string", - "description": "Default Answer response when no good match is found in the knowledge base." - } - } - }, - "ImportJobOptions": { - "type": "object", - "description": "Project assets the needs to be imported.", - "additionalProperties": false, - "properties": { - "metadata": { - "$ref": "#/definitions/CreateProjectOptions" - }, - "assets": { - "$ref": "#/definitions/Assets" - }, - "fileUri": { - "type": "string", - "description": "Import data File URI." - } - } - }, - "JobMetadata": { - "description": "Represents the job metadata.", - "properties": { - "createdDateTime": { - "format": "date-time", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "type": "string" - }, - "jobId": { - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { - "$ref": "#/definitions/JobStatus" - } - }, - "required": [ - "jobId", - "lastUpdatedDateTime", - "createdDateTime", - "status" - ], - "type": "object" - }, - "JobStatus": { - "description": "Job Status.", - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling", - "partiallyCompleted" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "jobStatus" - } - }, - "JobState": { - "description": "Job state represents the job metadata and any errors.", - "allOf": [ - { - "$ref": "#/definitions/JobMetadata" - }, - { - "$ref": "#/definitions/Errors" - } - ] - }, - "Errors": { - "description": "Collection of Error types.", - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - } - } - }, - "ExportJobState": { - "description": "Export job status, project metadata, and assets.", - "allOf": [ - { - "$ref": "#/definitions/JobState" - }, - { - "$ref": "#/definitions/ExportJobResultUrl" - } - ] - }, - "ExportJobResultUrl": { - "type": "object", - "description": "URL to download the result of the Export Job.", - "required": [ - "resultUrl" - ], - "properties": { - "resultUrl": { - "type": "string", - "description": "URL to download the result of the Export Job." - } - } - }, - "Assets": { - "type": "object", - "description": "All assets for this project.", - "additionalProperties": false, - "properties": { - "synonyms": { - "$ref": "#/definitions/SynonymAsset" - }, - "qnas": { - "$ref": "#/definitions/ImportQnaAsset" - } - } - }, - "SynonymAssets": { - "type": "object", - "description": "All synonym assets for this project.", - "additionalProperties": false, - "properties": { - "value": { - "$ref": "#/definitions/SynonymAsset" - }, - "nextLink": { - "type": "string" - } - } - }, - "SynonymAsset": { - "type": "array", - "description": "Collection of synonyms.", - "additionalProperties": false, - "maxLength": 10000, - "items": { - "$ref": "#/definitions/WordAlterations" - } - }, - "WordAlterations": { - "type": "object", - "description": "Collection of word alterations.", - "additionalProperties": false, - "required": [ - "alterations" - ], - "properties": { - "alterations": { - "type": "array", - "description": "Collection of word alterations.", - "maxLength": 20, - "items": { - "type": "string" - } - } - } - }, - "QnaAssets": { - "type": "object", - "description": "All QnA assets for the project.", - "additionalProperties": false, - "properties": { - "value": { - "$ref": "#/definitions/QnaAsset" - }, - "nextLink": { - "type": "string" - } - } - }, - "ImportQnaAsset": { - "type": "array", - "description": "List of QnA records to import.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/ImportQnaRecord" - } - }, - "QnaAsset": { - "type": "array", - "description": "List of QnA records.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/RetrieveQnaRecord" - } - }, - "QnaRecord": { - "type": "object", - "description": "QnA record.", - "additionalProperties": false, - "properties": { - "id": { - "type": "integer", - "description": "Unique ID for the QnA.", - "format": "int32" - }, - "answer": { - "type": "string", - "description": "Answer text.", - "maxLength": 25000, - "minLength": 1 - }, - "source": { - "type": "string", - "description": "Source from which QnA was indexed e.g. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .", - "maxLength": 300 - }, - "questions": { - "type": "array", - "description": "List of questions associated with the answer.", - "maxLength": 100, - "minLength": 1, - "items": { - "type": "string" - } - }, - "metadata": { - "type": "object", - "description": "Metadata associated with the answer, useful to categorize or filter question answers.", - "additionalProperties": { - "type": "string" - } - }, - "dialog": { - "description": "Context of a QnA.", - "$ref": "#/definitions/QnaDialog" - }, - "activeLearningSuggestions": { - "type": "array", - "description": "List of Active Learning suggestions for the QnA.", - "items": { - "$ref": "#/definitions/SuggestedQuestionsCluster" - } - } - } - }, - "SuggestedQuestionsCluster": { - "type": "object", - "description": "Active Learning suggested questions cluster details.", - "additionalProperties": false, - "properties": { - "clusterHead": { - "type": "string", - "description": "Question chosen as the head of suggested questions cluster by Active Learning clustering algorithm." - }, - "suggestedQuestions": { - "type": "array", - "description": "List of all suggested questions for the QnA.", - "items": { - "$ref": "#/definitions/SuggestedQuestion" - } - } - } - }, - "SuggestedQuestion": { - "type": "object", - "description": "Question suggested by the Active Learning feature.", - "additionalProperties": false, - "properties": { - "question": { - "type": "string", - "description": "Question suggested by the Active Learning feature." - }, - "userSuggestedCount": { - "type": "integer", - "description": "The number of times the question was suggested explicitly by the user.", - "format": "int32" - }, - "autoSuggestedCount": { - "type": "integer", - "description": "The number of times the question was suggested automatically by the Active Learning algorithm.", - "format": "int32" - } - } - }, - "ImportQnaRecord": { - "description": "Import QnA Record.", - "allOf": [ - { - "$ref": "#/definitions/RetrieveQnaRecord" - }, - { - "$ref": "#/definitions/SourceDisplayNameParameter" - } - ] - }, - "SourceDisplayNameParameter": { - "type": "object", - "properties": { - "sourceDisplayName": { - "description": "Friendly name of the Source.", - "type": "string", - "maxLength": 200, - "minLength": 1 - } - } - }, - "RetrieveQnaRecord": { - "description": "QnA Record with last updated date-time.", - "allOf": [ - { - "$ref": "#/definitions/QnaRecord" - }, - { - "$ref": "#/definitions/LastUpdatedDateTimeParameter" - } - ] - }, - "LastUpdatedDateTimeParameter": { - "type": "object", - "description": "Last updated date-time parameter.", - "properties": { - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "Date-time when the QnA was last updated." - } - } - }, - "QnaDialog": { - "type": "object", - "description": "Dialog associated with QnA Record.", - "properties": { - "isContextOnly": { - "type": "boolean", - "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as answer for queries without context; otherwise, ignores context and includes this QnA in answers." - }, - "prompts": { - "type": "array", - "description": "List of prompts associated with the answer.", - "maxItems": 20, - "items": { - "$ref": "#/definitions/QnaPrompt" - } - } - } - }, - "QnaPrompt": { - "type": "object", - "description": "Prompt for an answer.", - "properties": { - "displayOrder": { - "type": "integer", - "description": "Index of the prompt. It is used for ordering of the prompts.", - "format": "int32" - }, - "qnaId": { - "type": "integer", - "description": "ID of the QnA corresponding to the prompt.", - "format": "int32" - }, - "qna": { - "description": "QnA record. Either QnAId or QnA record needs to be present in a Prompt.", - "$ref": "#/definitions/QnaRecord" - }, - "displayText": { - "type": "string", - "description": "Text displayed to represent a follow up question prompt.", - "maxLength": 200 - } - } - }, - "UpdateOperationKind": { - "type": "string", - "description": "Update operation type for assets.", - "enum": [ - "add", - "delete", - "replace" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "updateOperationKind" - } - }, - "UpdateSourcesOptions": { - "type": "array", - "description": "A list of sources to be updated.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/UpdateSourceRecord" - } - }, - "UpdateQnaOptions": { - "type": "array", - "description": "A list of QnAs to be updated.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/UpdateQnaRecord" - } - }, - "UpdateQnaRecord": { - "type": "object", - "description": "QnA record to be updated.", - "additionalProperties": false, - "required": [ - "op", - "value" - ], - "properties": { - "op": { - "type": "string", - "$ref": "#/definitions/UpdateOperationKind" - }, - "value": { - "$ref": "#/definitions/QnaRecord" - } - } - }, - "UpdateSourceRecord": { - "type": "object", - "description": "Source to be updated.", - "additionalProperties": false, - "required": [ - "op", - "value" - ], - "properties": { - "op": { - "type": "string", - "$ref": "#/definitions/UpdateOperationKind" - }, - "value": { - "$ref": "#/definitions/UpdateQnaSourceRecord" - } - } - }, - "QnaSources": { - "type": "object", - "description": "All QnA sources for the project.", - "additionalProperties": false, - "properties": { - "value": { - "$ref": "#/definitions/QnaSourcesMetadata" - }, - "nextLink": { - "type": "string" - } - } - }, - "QnaSourcesMetadata": { - "type": "array", - "description": "Custom sources from which QnAs were extracted or explicitly added to the project.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/QnaSourceRecord" - } - }, - "QnaSourceRecord": { - "description": "Custom source record with last updated date-time.", - "allOf": [ - { - "$ref": "#/definitions/QnaSourceMetadata" - }, - { - "$ref": "#/definitions/LastUpdatedDateTimeParameter" - } - ] - }, - "UpdateQnaSourceRecord": { - "description": "Update source record.", - "allOf": [ - { - "$ref": "#/definitions/QnaSourceMetadata" - }, - { - "$ref": "#/definitions/RefreshSourceOptions" - } - ] - }, - "RefreshSourceOptions": { - "type": "object", - "description": "Boolean flag used to refresh data from the Source.", - "properties": { - "refresh": { - "type": "boolean", - "description": "Boolean flag used to refresh data from the Source." - } - } - }, - "QnaSourceMetadata": { - "type": "object", - "description": "Input source file or url details.", - "additionalProperties": false, - "required": [ - "sourceUri", - "sourceKind", - "source" - ], - "properties": { - "displayName": { - "type": "string", - "description": "Friendly name of the Source.", - "maxLength": 200, - "minLength": 1 - }, - "source": { - "type": "string", - "description": "Unique source identifier. Name of the file if it's a 'file' source; otherwise, the complete URL if it's a 'url' source." - }, - "sourceUri": { - "type": "string", - "description": "URI location for the file or url.", - "format": "uri" - }, - "sourceKind": { - "type": "string", - "$ref": "#/definitions/QnaSourceKind", - "default": "url" - }, - "contentStructureKind": { - "type": "string", - "$ref": "#/definitions/SourceContentStructureKind", - "default": "Unstructured" - } - } - }, - "QnaSourceKind": { - "type": "string", - "description": "Supported source types.", - "x-ms-enum": { - "name": "sourceKind", - "modelAsString": true - }, - "enum": [ - "file", - "url" - ] - }, - "SourceContentStructureKind": { - "type": "string", - "description": "Content structure type for sources.", - "enum": [ - "unstructured" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "sourceContentStructureKind" - } - }, - "ProjectDeployments": { - "type": "object", - "description": "All deployments of a project.", - "additionalProperties": false, - "properties": { - "value": { - "$ref": "#/definitions/ProjectDeploymentsList" - }, - "nextLink": { - "type": "string" - } - } - }, - "ProjectDeploymentsList": { - "type": "array", - "description": "List of deployments of a project.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/ProjectDeployment" - } - }, - "ProjectDeployment": { - "type": "object", - "description": "Project deployment details.", - "additionalProperties": false, - "properties": { - "deploymentName": { - "type": "string", - "description": "Name of the deployment." - }, - "lastDeployedDateTime": { - "type": "string", - "description": "Represents the project last deployment date-time.", - "format": "date-time" - } - } - } - }, - "parameters": { - "JobIdParameter": { - "name": "jobId", - "in": "path", - "description": "Job ID.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AssetKindParameter": { - "name": "assetKind", - "type": "string", - "in": "query", - "description": "Kind of the asset of the project.", - "enum": [ - "qnas", - "synonyms" - ], - "x-ms-parameter-location": "method" - }, - "ImportExportFormatParameter": { - "name": "format", - "type": "string", - "in": "query", - "description": "Knowledge base Import or Export format.", - "default": "json", - "enum": [ - "json", - "tsv", - "excel" - ], - "x-ms-enum": { - "name": "format", - "modelAsString": true, - "values": [ - { - "value": "json", - "description": "Export or Import QnA assets in JSON format." - }, - { - "value": "tsv", - "description": "Export or Import knowledge base replica including all assets and metadata in Excel format." - }, - { - "value": "excel", - "description": "Export or Import knowledge base replica including all assets and metadata in Tsv format." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "SourceFilterParameter": { - "name": "source", - "in": "query", - "description": "Source of the QnA.", - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/questionanswering.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/questionanswering.json deleted file mode 100644 index 3809c333c119..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/questionanswering.json +++ /dev/null @@ -1,600 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Question Answering", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2022-07-01-preview" - }, - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" - } - }, - "apim_key": { - "type": "apiKey", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://cognitiveservices.azure.com/.default" - ] - }, - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/:query-knowledgebases": { - "post": { - "summary": "Answers the specified question using your knowledge base.", - "operationId": "QuestionAnswering_GetAnswers", - "parameters": [ - { - "$ref": "#/parameters/AnswersOptions" - }, - { - "$ref": "common.json#/parameters/ProjectNameQueryParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNameQueryParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "A successful response to get answers from knowledge base.", - "schema": { - "$ref": "#/definitions/AnswersResult" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/SuccessfulQueryKnowledgebases.json" - } - } - } - }, - "/:query-text": { - "post": { - "summary": "Answers the specified question using the provided text in the body.", - "operationId": "QuestionAnswering_GetAnswersFromText", - "parameters": [ - { - "$ref": "#/parameters/AnswersFromTextOptions" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "A successful response to get answers from input text.", - "schema": { - "$ref": "#/definitions/AnswersFromTextResult" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/SuccessfulQueryText.json" - } - } - } - } - }, - "definitions": { - "AnswersOptions": { - "type": "object", - "description": "Parameters to query a knowledge base.", - "additionalProperties": false, - "properties": { - "qnaId": { - "type": "integer", - "description": "Exact QnA ID to fetch from the knowledge base, this field takes priority over question.", - "format": "int32" - }, - "question": { - "type": "string", - "description": "User question to query against the knowledge base." - }, - "top": { - "type": "integer", - "description": "Max number of answers to be returned for the question.", - "format": "int32" - }, - "userId": { - "type": "string", - "description": "Unique identifier for the user." - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidenceThreshold", - "description": "Minimum threshold score for answers, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "context": { - "x-ms-client-name": "answerContext", - "description": "Context object with previous QnA's information.", - "$ref": "#/definitions/KnowledgeBaseAnswerContext" - }, - "rankerType": { - "type": "string", - "x-ms-client-name": "rankerKind", - "description": "Type of ranker to be used.", - "x-ms-enum": { - "name": "RankerKind", - "modelAsString": true, - "values": [ - { - "value": "QuestionOnly", - "description": "Question only ranker." - }, - { - "value": "Default", - "description": "Default ranker." - } - ] - }, - "enum": [ - "Default", - "QuestionOnly" - ] - }, - "filters": { - "description": "Filter QnAs based on given metadata list and knowledge base sources.", - "$ref": "#/definitions/QueryFilters" - }, - "answerSpanRequest": { - "x-ms-client-name": "shortAnswerOptions", - "description": "To configure Answer span prediction feature.", - "$ref": "#/definitions/ShortAnswerOptions" - }, - "includeUnstructuredSources": { - "type": "boolean", - "description": "(Optional) Flag to enable Query over Unstructured Sources." - } - } - }, - "ShortAnswerOptions": { - "type": "object", - "description": "To configure Answer span prediction feature.", - "additionalProperties": false, - "required": [ - "enable" - ], - "properties": { - "enable": { - "type": "boolean", - "description": "Enable or disable Answer Span prediction.", - "enum": [ - true - ], - "x-ms-enum": { - "name": "enable", - "modelAsString": false - } - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidenceThreshold", - "description": "Minimum threshold score required to include an answer span, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "topAnswersWithSpan": { - "type": "integer", - "x-ms-client-name": "top", - "description": "Number of Top answers to be considered for span prediction from 1 to 10.", - "format": "int32", - "maximum": 10, - "minimum": 1 - } - } - }, - "KnowledgeBaseAnswerContext": { - "type": "object", - "description": "Context object with previous QnA's information.", - "additionalProperties": false, - "required": [ - "previousQnaId" - ], - "properties": { - "previousQnaId": { - "type": "integer", - "description": "Previous turn top answer result QnA ID.", - "format": "int32" - }, - "previousUserQuery": { - "type": "string", - "x-ms-client-name": "previousQuestion", - "description": "Previous user query." - } - } - }, - "AnswersResult": { - "type": "object", - "description": "Represents List of Question Answers.", - "additionalProperties": false, - "properties": { - "answers": { - "type": "array", - "description": "Represents Answer Result list.", - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswer" - } - } - } - }, - "KnowledgeBaseAnswer": { - "type": "object", - "description": "Represents knowledge base answer.", - "additionalProperties": false, - "properties": { - "questions": { - "type": "array", - "description": "List of questions associated with the answer.", - "items": { - "type": "string" - } - }, - "answer": { - "type": "string", - "description": "Answer text." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidence", - "description": "Answer confidence score, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "id": { - "type": "integer", - "x-ms-client-name": "qnaId", - "description": "ID of the QnA result.", - "format": "int32" - }, - "source": { - "type": "string", - "description": "Source of QnA result." - }, - "metadata": { - "type": "object", - "description": "Metadata associated with the answer, useful to categorize or filter question answers.", - "additionalProperties": { - "type": "string" - } - }, - "dialog": { - "type": "object", - "$ref": "#/definitions/KnowledgeBaseAnswerDialog" - }, - "answerSpan": { - "type": "object", - "x-ms-client-name": "shortAnswer", - "description": "Answer span object of QnA with respect to user's question.", - "$ref": "#/definitions/AnswerSpan" - } - } - }, - "KnowledgeBaseAnswerDialog": { - "type": "object", - "description": "Dialog associated with Answer.", - "properties": { - "isContextOnly": { - "type": "boolean", - "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as search result for queries without context; otherwise, if false, ignores context and includes this QnA in search result." - }, - "prompts": { - "type": "array", - "description": "List of prompts associated with the answer.", - "maxItems": 20, - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswerPrompt" - } - } - } - }, - "KnowledgeBaseAnswerPrompt": { - "type": "object", - "description": "Prompt for an answer.", - "properties": { - "displayOrder": { - "type": "integer", - "description": "Index of the prompt - used in ordering of the prompts.", - "format": "int32" - }, - "qnaId": { - "type": "integer", - "description": "QnA ID corresponding to the prompt.", - "format": "int32" - }, - "displayText": { - "type": "string", - "description": "Text displayed to represent a follow up question prompt.", - "maxLength": 200 - } - } - }, - "QueryFilters": { - "type": "object", - "description": "filters over knowledge base.", - "additionalProperties": false, - "properties": { - "metadataFilter": { - "type": "object", - "$ref": "#/definitions/MetadataFilter" - }, - "sourceFilter": { - "type": "object", - "$ref": "#/definitions/SourceFilter" - }, - "logicalOperation": { - "type": "string", - "description": "Logical operation used to join metadata filter with source filter.", - "$ref": "#/definitions/LogicalOperationKind", - "default": "AND" - } - } - }, - "MetadataFilter": { - "type": "object", - "description": "Find QnAs that are associated with the given list of metadata.", - "additionalProperties": false, - "properties": { - "metadata": { - "type": "array", - "items": { - "$ref": "#/definitions/MetadataRecord" - } - }, - "logicalOperation": { - "type": "string", - "description": "Operation used to join metadata filters.", - "$ref": "#/definitions/LogicalOperationKind", - "default": "AND" - } - } - }, - "MetadataRecord": { - "type": "object", - "description": "Object to provide the key value pair for each metadata.", - "additionalProperties": false, - "required": [ - "key", - "value" - ], - "properties": { - "key": { - "type": "string", - "description": "Metadata Key from Metadata dictionary used in the QnA." - }, - "value": { - "type": "string", - "description": "Metadata Value from Metadata dictionary used in the QnA." - } - } - }, - "LogicalOperationKind": { - "type": "string", - "description": "Set to 'OR' or 'AND' for using corresponding logical operation.", - "x-ms-enum": { - "name": "LogicalOperationKind", - "modelAsString": true - }, - "enum": [ - "AND", - "OR" - ] - }, - "SourceFilter": { - "type": "array", - "description": "Find QnAs that are associated with any of the given list of sources in knowledge base.", - "items": { - "type": "string" - } - }, - "AnswerSpan": { - "type": "object", - "description": "Answer span object of QnA.", - "additionalProperties": false, - "properties": { - "text": { - "type": "string", - "description": "Predicted text of answer span." - }, - "confidenceScore": { - "type": "number", - "x-ms-client-name": "confidence", - "description": "Predicted score of answer span, value ranges from 0 to 1.", - "format": "double", - "maximum": 1, - "minimum": 0 - }, - "offset": { - "type": "integer", - "description": "The answer span offset from the start of answer.", - "format": "int32" - }, - "length": { - "type": "integer", - "description": "The length of the answer span.", - "format": "int32" - } - } - }, - "AnswersFromTextOptions": { - "type": "object", - "description": "The question and text record parameters to answer.", - "required": [ - "question", - "records" - ], - "additionalProperties": false, - "properties": { - "question": { - "type": "string", - "description": "User question to query against the given text records." - }, - "records": { - "type": "array", - "x-ms-client-name": "textDocuments", - "description": "Text records to be searched for given question.", - "items": { - "$ref": "#/definitions/TextDocument" - } - }, - "language": { - "$ref": "common.json#/definitions/Language" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - } - }, - "AnswersFromTextResult": { - "type": "object", - "description": "Represents the answer results.", - "additionalProperties": false, - "properties": { - "answers": { - "type": "array", - "description": "Represents the answer results.", - "items": { - "$ref": "#/definitions/TextAnswer" - } - } - } - }, - "TextAnswer": { - "type": "object", - "description": "Represents answer result.", - "additionalProperties": false, - "properties": { - "answer": { - "type": "string", - "description": "Answer." - }, - "confidenceScore": { - "type": "number", - "x-ms-client-name": "confidence", - "description": "answer confidence score, value ranges from 0 to 1.", - "format": "double", - "maximum": 1, - "minimum": 0 - }, - "id": { - "type": "string", - "description": "record ID." - }, - "answerSpan": { - "type": "object", - "x-ms-client-name": "shortAnswer", - "description": "Answer span object with respect to user's question.", - "$ref": "#/definitions/AnswerSpan" - }, - "offset": { - "type": "integer", - "description": "The sentence offset from the start of the document.", - "format": "int32" - }, - "length": { - "type": "integer", - "description": "The length of the sentence.", - "format": "int32" - } - } - }, - "TextDocument": { - "type": "object", - "description": "Represent input text record to be queried.", - "additionalProperties": false, - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the text record." - }, - "text": { - "type": "string", - "description": "Text contents of the record." - } - } - } - }, - "parameters": { - "AnswersOptions": { - "name": "knowledgeBaseQueryOptions", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AnswersOptions" - }, - "x-nullable": true, - "description": "Post body of the request.", - "x-ms-parameter-location": "method" - }, - "AnswersFromTextOptions": { - "name": "textQueryOptions", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AnswersFromTextOptions" - }, - "x-nullable": true, - "description": "Post body of the request.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/analyzeconversations-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/analyzeconversations-authoring.json deleted file mode 100644 index aa478038c783..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/analyzeconversations-authoring.json +++ /dev/null @@ -1,3926 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Analyze Conversations Authoring", - "version": "2022-10-01-preview", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview." - }, - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" - } - }, - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://cognitiveservices.azure.com/.default" - ] - }, - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/authoring/analyze-conversations/projects": { - "get": { - "description": "Lists the existing projects.", - "operationId": "ConversationalAnalysisAuthoring_ListProjects", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of projects.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectsMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Projects": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListProjects.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}": { - "patch": { - "description": "Creates a new project or updates an existing one.", - "operationId": "ConversationalAnalysisAuthoring_CreateProject", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The project parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of the updated project, if it already exists.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "201": { - "description": "The metadata of the created project.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Create Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateProject.json" - } - } - }, - "get": { - "description": "Gets the details of a project.", - "operationId": "ConversationalAnalysisAuthoring_GetProject", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of the project.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProject.json" - } - } - }, - "delete": { - "description": "Deletes a project.", - "operationId": "ConversationalAnalysisAuthoring_DeleteProject", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/:export": { - "post": { - "description": "Triggers a job to export a project's data.", - "operationId": "ConversationalAnalysisAuthoring_Export", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryOptionalParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" - }, - { - "in": "query", - "name": "assetKind", - "description": "Kind of asset to export.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "in": "query", - "name": "trainedModelLabel", - "description": "Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Export Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulExportProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/:import": { - "post": { - "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", - "operationId": "ConversationalAnalysisAuthoring_Import", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryOptionalParameter" - }, - { - "in": "body", - "name": "body", - "description": "The project data to import.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProject" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Import Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulImportProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/:train": { - "post": { - "description": "Triggers a training job for a project.", - "operationId": "ConversationalAnalysisAuthoring_Train", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The training input parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Train Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulTrainProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments": { - "get": { - "description": "Lists the deployments belonging to a project.", - "operationId": "ConversationalAnalysisAuthoring_ListDeployments", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all deployments.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployments" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeployments.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { - "post": { - "description": "Swaps two existing deployments with each other.", - "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The job object to swap two deployments.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Swap Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": { - "get": { - "description": "Gets the details of a deployment.", - "operationId": "ConversationalAnalysisAuthoring_GetDeployment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The Deployment info.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeployment.json" - } - } - }, - "put": { - "description": "Creates a new deployment or replaces an existing one.", - "operationId": "ConversationalAnalysisAuthoring_DeployProject", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The new deployment info.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateDeploymentOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Deploy Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeployProject.json" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "description": "Deletes a project deployment.", - "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources": { - "post": { - "description": "Deletes a project deployment from the specified assigned resources.", - "operationId": "ConversationalAnalysisAuthoring_DeleteDeploymentFromResources", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The options for deleting the deployment.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringDeleteDeploymentOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing delete deployment from specific resources job.", - "operationId": "ConversationalAnalysisAuthoring_GetDeploymentDeleteFromResourcesStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The deployment job result.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Delete Deployment From Resources Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeleteDeploymentFromResourcesStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing deployment job.", - "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The deployment job result.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Deployment Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing swap deployment job.", - "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The swap deployment job result.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Swap Deployments Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": { - "get": { - "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", - "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The status of the long running operation.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportProjectJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Export Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { - "get": { - "description": "Gets the status for an import.", - "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The details of the long running operation.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringImportProjectJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Import Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models": { - "get": { - "description": "Lists the trained models belonging to a project.", - "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all trained models.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModels" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Models": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListModels.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": { - "get": { - "description": "Gets the details of a trained model.", - "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Trained model info", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModel.json" - } - } - }, - "delete": { - "description": "Deletes an existing trained model.", - "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "204": { - "description": "Deleted successfully." - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteModel.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot": { - "post": { - "description": "Restores the snapshot of this trained model to be the current working directory of the project.", - "operationId": "ConversationalAnalysisAuthoring_LoadSnapshot", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results in loading the working directory with the snapshot of the model provided.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Load Snapshot": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { - "get": { - "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", - "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of the evaluation predictions.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationResults" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model Evaluation": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { - "get": { - "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", - "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all evaluation results.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationSummary" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model Evaluation Summary": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}": { - "get": { - "description": "Gets the status for loading a snapshot.", - "operationId": "ConversationalAnalysisAuthoring_GetLoadSnapshotStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The details of the long running operation.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringLoadSnapshotJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Load Snapshot Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/resources": { - "get": { - "description": "Lists the deployments resources assigned to the project.", - "operationId": "ConversationalAnalysisAuthoring_ListDeploymentResources", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The assigned deployment resources.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedDeploymentResources" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/resources/:assign": { - "post": { - "description": "Assign new Azure resources to a project to allow deploying new deployments to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory", - "operationId": "ConversationalAnalysisAuthoring_AssignDeploymentResources", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The new project resources info.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignDeploymentResourcesOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Assign Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/resources/:unassign": { - "post": { - "description": "Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them.", - "operationId": "ConversationalAnalysisAuthoring_UnassignDeploymentResources", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The info for the deployment resources to be deleted.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringUnassignDeploymentResourcesOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Unassign Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/resources/assign/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing assign deployment resources job.", - "operationId": "ConversationalAnalysisAuthoring_GetAssignDeploymentResourcesStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The assign deployment resources job result.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentResourcesJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Assign Deployment Resources Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing unassign deployment resources job.", - "operationId": "ConversationalAnalysisAuthoring_GetUnassignDeploymentResourcesStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The unassign deployment resources job result.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentResourcesJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Unassign Deployment Resources Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/train/jobs": { - "get": { - "description": "Lists the non-expired training jobs created for a project.", - "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of the training jobs.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobs" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Training Jobs": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": { - "get": { - "description": "Gets the status for a training job.", - "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The training job result.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Train Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": { - "post": { - "description": "Triggers a cancellation for a running training job.", - "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the job cancellation.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Cancel Training Job": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": { - "get": { - "description": "Gets the status for a project deletion job.", - "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The project deletion job result.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeletionJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Project Deletion Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/global/deployments/resources": { - "get": { - "description": "Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.", - "operationId": "ConversationalAnalysisAuthoring_ListAssignedResourceDeployments", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The assigned deployments metadata for the resource.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedResourceDeploymentsMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Assigned Resource Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/global/languages": { - "get": { - "description": "Lists the supported languages for the given project type.", - "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of supported languages.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguages" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Supported Languages": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/global/prebuilt-entities": { - "get": { - "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", - "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "language", - "description": "The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "in": "query", - "name": "multilingual", - "description": "Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of supported prebuilt entities.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntities" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Supported Prebuilt Entities": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-conversations/projects/global/training-config-versions": { - "get": { - "description": "Lists the support training config version for a given project type.", - "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of config versions.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersions" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Supported Training Config Versions": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - } - }, - "definitions": { - "ConversationalAnalysisAuthoringAssignDeploymentResourcesOptions": { - "description": "Represents the options for assigning Azure resources to a project.", - "required": [ - "resourcesMetadata" - ], - "type": "object", - "properties": { - "resourcesMetadata": { - "description": "Represents the metadata for the resources to be assigned.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringResourceMetadata" - } - } - }, - "x-ms-client-name": "AssignDeploymentResourcesOptions" - }, - "ConversationalAnalysisAuthoringAssignedDeploymentResource": { - "description": "Represents the assigned deployment resource.", - "required": [ - "azureResourceId", - "region" - ], - "type": "object", - "properties": { - "azureResourceId": { - "description": "The resource ID.", - "type": "string" - }, - "region": { - "description": "The resource region.", - "type": "string" - } - }, - "x-ms-client-name": "AssignedDeploymentResource" - }, - "ConversationalAnalysisAuthoringAssignedDeploymentResources": { - "description": "Represents the assigned deployment resources.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of assigned deployment resources.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedDeploymentResource" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "AssignedDeploymentResources" - }, - "ConversationalAnalysisAuthoringAssignedProjectDeploymentMetadata": { - "description": "Represents the metadata for an assigned deployment", - "required": [ - "deploymentName", - "lastDeployedDateTime", - "deploymentExpirationDate" - ], - "type": "object", - "properties": { - "deploymentName": { - "description": "Represents the deployment name.", - "type": "string" - }, - "lastDeployedDateTime": { - "format": "date-time", - "description": "Represents deployment last deployed time.", - "type": "string" - }, - "deploymentExpirationDate": { - "format": "date", - "description": "Represents deployment expiration date in the runtime.", - "type": "string" - } - }, - "x-ms-client-name": "AssignedProjectDeploymentMetadata" - }, - "ConversationalAnalysisAuthoringAssignedProjectDeploymentsMetadata": { - "description": "Represents the metadata for assigned deployments for a project.", - "required": [ - "projectName", - "deploymentsMetadata" - ], - "type": "object", - "properties": { - "projectName": { - "description": "Represents the project name.", - "type": "string" - }, - "deploymentsMetadata": { - "description": "Represents the resource region.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedProjectDeploymentMetadata" - } - } - }, - "x-ms-client-name": "AssignedProjectDeploymentsMetadata" - }, - "ConversationalAnalysisAuthoringAssignedResourceDeploymentsMetadata": { - "description": "Represents the metadata for deployments assigned to a resource.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved assigned project deployments.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedProjectDeploymentsMetadata" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "AssignedResourceDeploymentsMetadata" - }, - "ConversationalAnalysisAuthoringCompositionSetting": { - "enum": [ - "returnLongestOverlap", - "requireExactOverlap", - "separateComponents", - "combineComponents" - ], - "type": "string", - "x-ms-enum": { - "name": "CompositionSetting", - "modelAsString": true, - "values": [ - { - "value": "returnLongestOverlap", - "description": "When two or more components are found in the text and overlap, the component with the longest set of characters is returned." - }, - { - "value": "requireExactOverlap", - "description": "All components must overlap at the exact same characters in the text for the entity to return. If one of the defined components is not matched or predicted, the entity will not return." - }, - { - "value": "separateComponents", - "description": "Every component's match or prediction is returned as a separate instance of the entity." - }, - { - "value": "combineComponents", - "description": "When two or more components are found in the text and overlap, the components' spans are merged together into one span combining all of them." - } - ] - }, - "x-ms-client-name": "CompositionSetting" - }, - "ConversationalAnalysisAuthoringConfusionMatrix": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixRow" - }, - "x-ms-client-name": "ConfusionMatrix" - }, - "ConversationalAnalysisAuthoringConfusionMatrixCell": { - "description": "Represents a cell in a confusion matrix.", - "required": [ - "normalizedValue", - "rawValue" - ], - "type": "object", - "properties": { - "normalizedValue": { - "format": "float", - "description": "Represents normalized value in percentages.", - "type": "number" - }, - "rawValue": { - "format": "float", - "description": "Represents raw value.", - "type": "number" - } - }, - "x-ms-client-name": "ConfusionMatrixCell" - }, - "ConversationalAnalysisAuthoringConfusionMatrixRow": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixCell" - }, - "x-ms-client-name": "ConfusionMatrixRow" - }, - "ConversationalAnalysisAuthoringConversationExportedEntity": { - "description": "Represents an entity with its components.", - "required": [ - "category" - ], - "type": "object", - "properties": { - "category": { - "description": "The category of the entity.", - "type": "string" - }, - "compositionSetting": { - "description": "The behavior to follow when the entity's components overlap with each other.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringCompositionSetting" - }, - "list": { - "description": "The list component of the entity.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityList" - }, - "prebuilts": { - "description": "The prebuilt entities components.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedPrebuiltEntity" - } - }, - "regex": { - "description": "The regex component of the entity.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityRegex" - }, - "requiredComponents": { - "description": "The required components. Allowed values are 'learned', 'list', 'prebuilts' and 'regex'.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ms-client-name": "ConversationExportedEntity" - }, - "ConversationalAnalysisAuthoringConversationExportedIntent": { - "description": "Represents an exported intent of a conversational project.", - "required": [ - "category" - ], - "type": "object", - "properties": { - "category": { - "description": "The intent category.", - "type": "string" - } - }, - "x-ms-client-name": "ConversationExportedIntent" - }, - "ConversationalAnalysisAuthoringConversationExportedProjectAssets": { - "description": "Represents the exported assets of a conversational project.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" - } - ], - "properties": { - "intents": { - "description": "The intents defined in the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedIntent" - } - }, - "entities": { - "description": "The entities defined in the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedEntity" - } - }, - "utterances": { - "description": "The utterances defined in the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedUtterance" - } - } - }, - "x-ms-discriminator-value": "Conversation", - "x-ms-client-name": "ConversationExportedProjectAssets" - }, - "ConversationalAnalysisAuthoringConversationExportedUtterance": { - "description": "Represents an exported utterance for a conversational project.", - "required": [ - "text", - "intent" - ], - "type": "object", - "properties": { - "entities": { - "description": "Represents the entity labels of the utterance.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedUtteranceEntityLabel" - } - }, - "text": { - "description": "The utterance text.", - "type": "string" - }, - "language": { - "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "intent": { - "description": "The intent of the utterance.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "ConversationExportedUtterance" - }, - "ConversationalAnalysisAuthoringConversationSummarizationExportedProjectAssets": { - "type": "object", - "properties": { - "conversations": { - "description": "Represents the conversations of the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedConversation" - } - } - }, - "x-ms-client-name": "ConversationSummarizationExportedProjectAssets" - }, - "ConversationalAnalysisAuthoringCreateDeploymentOptions": { - "description": "Represents the options for creating or updating a project deployment.", - "required": [ - "trainedModelLabel" - ], - "type": "object", - "properties": { - "trainedModelLabel": { - "description": "Represents the trained model label.", - "type": "string" - }, - "assignedResourceIds": { - "description": "Represents the resource IDs to be assigned to the deployment.\n If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ms-client-name": "CreateDeploymentOptions" - }, - "ConversationalAnalysisAuthoringCreateProjectOptions": { - "description": "Represents the options used to create or update a project.", - "required": [ - "projectKind", - "projectName", - "language" - ], - "type": "object", - "properties": { - "projectKind": { - "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" - }, - "settings": { - "description": "The project settings.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" - }, - "storageInputContainerName": { - "description": "The storage container name in case of conversation summarization.", - "type": "string" - }, - "projectName": { - "description": "The new project name.", - "type": "string" - }, - "multilingual": { - "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" - }, - "description": { - "description": "The project description.", - "type": "string" - }, - "language": { - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "CreateProjectOptions" - }, - "ConversationalAnalysisAuthoringDeleteDeploymentOptions": { - "description": "Represents the options for deleting a project deployment.", - "type": "object", - "properties": { - "assignedResourceIds": { - "description": "Represents the resource IDs to delete the deployment from.\n If not provided, the deployment will be rolled out from all the resources it is deployed to.\n If provided, it will delete the deployment only from the specified assigned resources, and leave it for the rest.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ms-client-name": "DeleteDeploymentOptions" - }, - "ConversationalAnalysisAuthoringDeploymentJobState": { - "description": "Represents the state of a deployment job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "DeploymentJobState" - }, - "ConversationalAnalysisAuthoringDeploymentResource": { - "description": "Represents an Azure resource assigned to a deployment.", - "required": [ - "resourceId", - "region" - ], - "type": "object", - "properties": { - "resourceId": { - "description": "Represents the Azure resource Id.", - "type": "string" - }, - "region": { - "description": "Represents the resource region.", - "type": "string" - } - }, - "x-ms-client-name": "DeploymentResource" - }, - "ConversationalAnalysisAuthoringDeploymentResourcesJobState": { - "description": "Represents the state of a deployment resources job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "DeploymentResourcesJobState" - }, - "ConversationalAnalysisAuthoringEntitiesEvaluationSummary": { - "description": "Represents the evaluation result summary for the project's entities.", - "required": [ - "confusionMatrix", - "entities", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], - "type": "object", - "properties": { - "confusionMatrix": { - "description": "Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" - }, - "entities": { - "description": "Represents the entities evaluation summary.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringEntityEvaluationSummary" - } - }, - "microF1": { - "format": "float", - "description": "Represents the micro F1", - "type": "number" - }, - "microPrecision": { - "format": "float", - "description": "Represents the micro precision", - "type": "number" - }, - "microRecall": { - "format": "float", - "description": "Represents the micro recall", - "type": "number" - }, - "macroF1": { - "format": "float", - "description": "Represents the macro F1", - "type": "number" - }, - "macroPrecision": { - "format": "float", - "description": "Represents the macro precision", - "type": "number" - }, - "macroRecall": { - "format": "float", - "description": "Represents the macro recall", - "type": "number" - } - }, - "x-ms-client-name": "EntitiesEvaluationSummary" - }, - "ConversationalAnalysisAuthoringEntityEvaluationSummary": { - "description": "Represents the evaluation result for an entity.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], - "type": "object", - "properties": { - "f1": { - "format": "double", - "description": "Represents the model precision", - "type": "number" - }, - "precision": { - "format": "double", - "description": "Represents the model recall", - "type": "number" - }, - "recall": { - "format": "double", - "description": "Represents the model F1 score", - "type": "number" - }, - "truePositiveCount": { - "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" - }, - "trueNegativeCount": { - "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" - }, - "falsePositiveCount": { - "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" - }, - "falseNegativeCount": { - "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" - } - }, - "x-ms-client-name": "EntityEvaluationSummary" - }, - "ConversationalAnalysisAuthoringEvaluationKind": { - "enum": [ - "percentage", - "manual" - ], - "type": "string", - "x-ms-enum": { - "name": "EvaluationKind", - "modelAsString": true, - "values": [ - { - "value": "percentage", - "description": "Split the data into training and test sets according to user-defined percentages." - }, - { - "value": "manual", - "description": "Split the data according to the chosen dataset for every example in the data." - } - ] - }, - "x-ms-client-name": "EvaluationKind" - }, - "ConversationalAnalysisAuthoringEvaluationOptions": { - "description": "Represents the options used running the evaluation.", - "type": "object", - "properties": { - "kind": { - "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationKind" - }, - "trainingSplitPercentage": { - "format": "int32", - "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" - }, - "testingSplitPercentage": { - "format": "int32", - "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" - } - }, - "x-ms-client-name": "EvaluationOptions" - }, - "ConversationalAnalysisAuthoringEvaluationResults": { - "description": "Represent a list of utterances' evaluation results.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The utterances evaluation results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEvaluationResult" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "EvaluationResults" - }, - "ConversationalAnalysisAuthoringEvaluationSummary": { - "description": "Represents the evaluation result summary.", - "required": [ - "entitiesEvaluation", - "intentsEvaluation" - ], - "type": "object", - "properties": { - "entitiesEvaluation": { - "description": "Contains the data related to entities evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEntitiesEvaluationSummary" - }, - "intentsEvaluation": { - "description": "Contains the data related to intents evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentsEvaluationSummary" - }, - "evaluationOptions": { - "description": "The options that were used while running the evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" - } - }, - "x-ms-client-name": "EvaluationSummary" - }, - "ConversationalAnalysisAuthoringExportedConversation": { - "description": "Represents a conversation.", - "required": [ - "location", - "summaryLocation" - ], - "type": "object", - "properties": { - "location": { - "description": "Represents the conversation file location in the blob store container associated with the project.", - "type": "string" - }, - "summaryLocation": { - "description": "Represents the summary file location in the blob store container associated with the project.", - "type": "string" - }, - "language": { - "description": "Represents the language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this conversation. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedConversation" - }, - "ConversationalAnalysisAuthoringExportedConversationOrchestration": { - "description": "Defines the orchestration details for a Conversational project target.", - "required": [ - "projectName", - "deploymentName" - ], - "type": "object", - "properties": { - "projectName": { - "description": "The name of the targeted project.", - "type": "string" - }, - "deploymentName": { - "description": "The name of the targeted deployment.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedConversationOrchestration" - }, - "ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions": { - "description": "Represents the orchestration options for a Conversational project target.", - "required": [ - "conversationOrchestration" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" - } - ], - "properties": { - "conversationOrchestration": { - "description": "The Conversational project target details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedConversationOrchestration" - } - }, - "x-ms-discriminator-value": "Conversation", - "x-ms-client-name": "ExportedConversationOrchestrationOptions" - }, - "ConversationalAnalysisAuthoringExportedEntityList": { - "description": "Represents a list component of an entity.", - "type": "object", - "properties": { - "sublists": { - "description": "The sub-lists of the list component.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntitySublist" - } - } - }, - "x-ms-client-name": "ExportedEntityList" - }, - "ConversationalAnalysisAuthoringExportedEntityListSynonym": { - "description": "Represents a list of synonyms inside a list component", - "type": "object", - "properties": { - "language": { - "description": "Represents the language of the synonyms. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "values": { - "description": "The list of synonyms.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ms-client-name": "ExportedEntityListSynonym" - }, - "ConversationalAnalysisAuthoringExportedEntityRegex": { - "description": "Represents a regex component of an entity.", - "type": "object", - "properties": { - "expressions": { - "description": "The regex expressions of the regex component. These expressions follow the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityRegexExpression" - } - } - }, - "x-ms-client-name": "ExportedEntityRegex" - }, - "ConversationalAnalysisAuthoringExportedEntityRegexExpression": { - "description": "Represents a regex expression inside a regex component. This expression follows the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", - "type": "object", - "properties": { - "regexKey": { - "description": "The key of the regex expression.", - "type": "string" - }, - "language": { - "description": "Represents the language of the regex expression. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "regexPattern": { - "description": "The regex pattern.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedEntityRegexExpression" - }, - "ConversationalAnalysisAuthoringExportedEntitySublist": { - "description": "Represents a sub-list inside a list component.", - "type": "object", - "properties": { - "listKey": { - "description": "The key of the sub-list.", - "type": "string" - }, - "synonyms": { - "description": "The phrases of that correspond to the sub-list.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityListSynonym" - } - } - }, - "x-ms-client-name": "ExportedEntitySublist" - }, - "ConversationalAnalysisAuthoringExportedLuisOrchestration": { - "description": "Defines the orchestration details for a LUIS application target.", - "required": [ - "appId" - ], - "type": "object", - "properties": { - "appId": { - "format": "uuid", - "description": "The LUIS application ID.", - "type": "string", - "example": "00000000-0000-0000-0000-000000000000" - }, - "appVersion": { - "description": "The targeted version Id.", - "type": "string" - }, - "slotName": { - "description": "The targeted slot name.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedLuisOrchestration" - }, - "ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions": { - "description": "Represents the orchestration options for a LUIS application target.", - "required": [ - "luisOrchestration" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" - } - ], - "properties": { - "luisOrchestration": { - "description": "The LUIS application target details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedLuisOrchestration" - } - }, - "x-ms-discriminator-value": "Luis", - "x-ms-client-name": "ExportedLuisOrchestrationOptions" - }, - "ConversationalAnalysisAuthoringExportedOrchestrationOptions": { - "description": "Represents the options used to define the orchestration behavior of an intent.", - "required": [ - "targetProjectKind" - ], - "type": "object", - "properties": { - "targetProjectKind": { - "description": "The kind of the target used in the orchestration flow.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationTargetProjectKind" - } - }, - "discriminator": "targetProjectKind", - "x-ms-client-name": "ExportedOrchestrationOptions" - }, - "ConversationalAnalysisAuthoringExportedPrebuiltEntity": { - "description": "Represents an exported prebuilt entity component", - "required": [ - "category" - ], - "type": "object", - "properties": { - "category": { - "description": "The prebuilt entity category.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedPrebuiltEntity" - }, - "ConversationalAnalysisAuthoringExportedProject": { - "description": "Represents an exported project.", - "required": [ - "projectFileVersion", - "stringIndexType", - "metadata" - ], - "type": "object", - "properties": { - "projectFileVersion": { - "description": "The version of the exported file.", - "type": "string" - }, - "stringIndexType": { - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringStringIndexType" - }, - "metadata": { - "description": "Represents the project metadata.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" - }, - "assets": { - "description": "Represents the project assets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" - } - }, - "x-ms-client-name": "ExportedProject" - }, - "ConversationalAnalysisAuthoringExportedProjectAssets": { - "description": "Represents the assets of an exported project.", - "required": [ - "projectKind" - ], - "type": "object", - "properties": { - "projectKind": { - "description": "The type of project containing the assets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" - } - }, - "discriminator": "projectKind", - "x-ms-client-name": "ExportedProjectAssets" - }, - "ConversationalAnalysisAuthoringExportedProjectFormat": { - "enum": [ - "Conversation", - "Luis" - ], - "type": "string", - "x-ms-enum": { - "name": "ExportedProjectFormat", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "Specifies the format for a conversational project." - }, - { - "value": "Luis", - "description": "Specifies the format for an application that was exported from LUIS." - } - ] - }, - "x-ms-client-name": "ExportedProjectFormat" - }, - "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration": { - "description": "Defines the orchestration details for a Question Answering project target.", - "required": [ - "projectName" - ], - "type": "object", - "properties": { - "projectName": { - "description": "The name of the target project.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedQuestionAnsweringOrchestration" - }, - "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions": { - "description": "Represents the orchestration options for a Question Answering project target.", - "required": [ - "questionAnsweringOrchestration" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" - } - ], - "properties": { - "questionAnsweringOrchestration": { - "description": "The Question Answering project details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration" - } - }, - "x-ms-discriminator-value": "QuestionAnswering", - "x-ms-client-name": "ExportedQuestionAnsweringOrchestrationOptions" - }, - "ConversationalAnalysisAuthoringExportedUtteranceEntityLabel": { - "description": "Represents an entity label for an utterance.", - "required": [ - "category", - "offset", - "length" - ], - "type": "object", - "properties": { - "category": { - "description": "The category of the entity label.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "Start position for the entity text.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "Length for the entity text.", - "type": "integer" - } - }, - "x-ms-client-name": "ExportedUtteranceEntityLabel" - }, - "ConversationalAnalysisAuthoringExportProjectJobState": { - "description": "Represents the state of an export job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "properties": { - "resultUrl": { - "description": "The URL to use in order to download the exported project.", - "type": "string" - } - }, - "x-ms-client-name": "ExportProjectJobState" - }, - "ConversationalAnalysisAuthoringImportProjectJobState": { - "description": "Represents the state of an import job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "ImportProjectJobState" - }, - "ConversationalAnalysisAuthoringIntentEvaluationSummary": { - "description": "The evaluation summary for an intent.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], - "type": "object", - "properties": { - "f1": { - "format": "double", - "description": "Represents the model precision", - "type": "number" - }, - "precision": { - "format": "double", - "description": "Represents the model recall", - "type": "number" - }, - "recall": { - "format": "double", - "description": "Represents the model F1 score", - "type": "number" - }, - "truePositiveCount": { - "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" - }, - "trueNegativeCount": { - "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" - }, - "falsePositiveCount": { - "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" - }, - "falseNegativeCount": { - "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" - } - }, - "x-ms-client-name": "IntentEvaluationSummary" - }, - "ConversationalAnalysisAuthoringIntentsEvaluationSummary": { - "description": "Represents the evaluation summary for the project's intents.", - "required": [ - "confusionMatrix", - "intents", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], - "type": "object", - "properties": { - "confusionMatrix": { - "description": "Represents the confusion matrix between two intents (the two intents can be the same). The matrix is between the intent that was labelled and the intent that was predicted.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" - }, - "intents": { - "description": "Represents the intents evaluation summary.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentEvaluationSummary" - } - }, - "microF1": { - "format": "float", - "description": "Represents the micro F1", - "type": "number" - }, - "microPrecision": { - "format": "float", - "description": "Represents the micro precision", - "type": "number" - }, - "microRecall": { - "format": "float", - "description": "Represents the micro recall", - "type": "number" - }, - "macroF1": { - "format": "float", - "description": "Represents the macro F1", - "type": "number" - }, - "macroPrecision": { - "format": "float", - "description": "Represents the macro precision", - "type": "number" - }, - "macroRecall": { - "format": "float", - "description": "Represents the macro recall", - "type": "number" - } - }, - "x-ms-client-name": "IntentsEvaluationSummary" - }, - "ConversationalAnalysisAuthoringJobState": { - "description": "Represents a job's state.", - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ], - "type": "object", - "properties": { - "jobId": { - "description": "The job ID.", - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "description": "The creation date time of the job.", - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "description": "The last date time the job was updated.", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "description": "The expiration date time of the job.", - "type": "string" - }, - "status": { - "description": "The job status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" - }, - "warnings": { - "description": "The warnings that were encountered while executing the job.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringWarning" - } - }, - "errors": { - "description": "The errors encountered while executing the job.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - } - }, - "x-ms-client-name": "JobState" - }, - "ConversationalAnalysisAuthoringJobStatus": { - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling", - "partiallyCompleted" - ], - "type": "string", - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true - }, - "x-ms-client-name": "JobStatus" - }, - "ConversationalAnalysisAuthoringLoadSnapshotJobState": { - "description": "Represents the state of loading a snapshot job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "LoadSnapshotJobState" - }, - "ConversationalAnalysisAuthoringOrchestrationExportedIntent": { - "description": "Represents an exported intent for an orchestration project.", - "required": [ - "category" - ], - "type": "object", - "properties": { - "orchestration": { - "description": "Specifies the behavior of this intent in the orchestration flow.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" - }, - "category": { - "description": "The intent category.", - "type": "string" - } - }, - "x-ms-client-name": "OrchestrationExportedIntent" - }, - "ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets": { - "description": "Represents the assets of an orchestration project.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" - } - ], - "properties": { - "intents": { - "description": "Represents the intents of the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedIntent" - } - }, - "utterances": { - "description": "Represents the utterances of the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedUtterance" - } - } - }, - "x-ms-discriminator-value": "Orchestration", - "x-ms-client-name": "OrchestrationExportedProjectAssets" - }, - "ConversationalAnalysisAuthoringOrchestrationExportedUtterance": { - "description": "Represents an utterance of an orchestration project.", - "required": [ - "text", - "intent" - ], - "type": "object", - "properties": { - "text": { - "description": "The utterance text.", - "type": "string" - }, - "language": { - "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "intent": { - "description": "The intent of the utterance.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "OrchestrationExportedUtterance" - }, - "ConversationalAnalysisAuthoringOrchestrationTargetProjectKind": { - "enum": [ - "Luis", - "Conversation", - "QuestionAnswering" - ], - "type": "string", - "x-ms-enum": { - "name": "OrchestrationTargetProjectKind", - "modelAsString": true - }, - "x-ms-client-name": "OrchestrationTargetProjectKind" - }, - "ConversationalAnalysisAuthoringPrebuiltEntities": { - "description": "Represents a list of the retrieved supported prebuilt entities.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The supported prebuilt entities.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntity" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "PrebuiltEntities" - }, - "ConversationalAnalysisAuthoringPrebuiltEntity": { - "description": "Represents a supported prebuilt entity.", - "required": [ - "category", - "description", - "examples" - ], - "type": "object", - "properties": { - "category": { - "description": "The prebuilt entity category.", - "type": "string" - }, - "description": { - "description": "The description.", - "type": "string" - }, - "examples": { - "description": "English examples for the entity.", - "type": "string" - } - }, - "x-ms-client-name": "PrebuiltEntity" - }, - "ConversationalAnalysisAuthoringProjectDeletionJobState": { - "description": "Represents the state of a project deletion job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "ProjectDeletionJobState" - }, - "ConversationalAnalysisAuthoringProjectDeployment": { - "description": "Represents a project deployment.", - "required": [ - "deploymentName", - "modelId", - "lastTrainedDateTime", - "lastDeployedDateTime", - "deploymentExpirationDate", - "modelTrainingConfigVersion" - ], - "type": "object", - "properties": { - "deploymentName": { - "description": "Represents deployment name.", - "type": "string" - }, - "modelId": { - "description": "Represents deployment modelId.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "Represents deployment last trained time.", - "type": "string" - }, - "lastDeployedDateTime": { - "format": "date-time", - "description": "Represents deployment last deployed time.", - "type": "string" - }, - "deploymentExpirationDate": { - "format": "date", - "description": "Represents deployment expiration date in the runtime.", - "type": "string" - }, - "modelTrainingConfigVersion": { - "description": "Represents model training config version.", - "type": "string" - }, - "assignedResources": { - "description": "Represents the metadata of the assigned Azure resources.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentResource" - } - } - }, - "x-ms-client-name": "ProjectDeployment" - }, - "ConversationalAnalysisAuthoringProjectDeployments": { - "description": "Represents a list of retrieved deployments.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved deployments.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectDeployments" - }, - "ConversationalAnalysisAuthoringProjectKind": { - "enum": [ - "Conversation", - "Orchestration", - "CustomConversationSummarization" - ], - "type": "string", - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "A project to build natural language into apps, bots, and IoT devices." - }, - { - "value": "Orchestration", - "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." - }, - { - "value": "CustomConversationSummarization", - "description": "A project to build conversation summarization models which are able to summarize long conversations." - } - ] - }, - "x-ms-client-name": "ProjectKind" - }, - "ConversationalAnalysisAuthoringProjectMetadata": { - "description": "Represents the metadata of a project.", - "required": [ - "createdDateTime", - "lastModifiedDateTime", - "projectKind", - "projectName", - "language" - ], - "type": "object", - "properties": { - "createdDateTime": { - "format": "date-time", - "description": "Represents the project creation datetime.", - "type": "string" - }, - "lastModifiedDateTime": { - "format": "date-time", - "description": "Represents the project creation datetime.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "Represents the project last trained datetime.", - "type": "string" - }, - "lastDeployedDateTime": { - "format": "date-time", - "description": "Represents the project last deployed datetime.", - "type": "string" - }, - "projectKind": { - "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" - }, - "settings": { - "description": "The project settings.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" - }, - "storageInputContainerName": { - "description": "The storage container name in case of conversation summarization.", - "type": "string" - }, - "projectName": { - "description": "The new project name.", - "type": "string" - }, - "multilingual": { - "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" - }, - "description": { - "description": "The project description.", - "type": "string" - }, - "language": { - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "ProjectMetadata" - }, - "ConversationalAnalysisAuthoringProjectSettings": { - "description": "Represents the settings used to define the project behavior.", - "required": [ - "confidenceThreshold" - ], - "type": "object", - "properties": { - "confidenceThreshold": { - "format": "float", - "description": "The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive.", - "type": "number" - } - }, - "x-ms-client-name": "ProjectSettings" - }, - "ConversationalAnalysisAuthoringProjectsMetadata": { - "description": "Represents a list of retrieved projects' metadata.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of projects.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectsMetadata" - }, - "ConversationalAnalysisAuthoringProjectTrainedModel": { - "description": "Represents a trained model.", - "required": [ - "label", - "modelId", - "lastTrainedDateTime", - "lastTrainingDurationInSeconds", - "modelExpirationDate", - "modelTrainingConfigVersion" - ], - "type": "object", - "properties": { - "label": { - "description": "The trained model label.", - "type": "string" - }, - "modelId": { - "description": "The model ID.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "The last trained date time of the model.", - "type": "string" - }, - "lastTrainingDurationInSeconds": { - "format": "int32", - "description": "The duration of the model's last training request in seconds.", - "type": "integer" - }, - "modelExpirationDate": { - "format": "date", - "description": "The model expiration date.", - "type": "string" - }, - "modelTrainingConfigVersion": { - "description": "The model training config version.", - "type": "string" - }, - "hasSnapshot": { - "description": "The flag to indicate if the trained model has a snapshot ready.", - "type": "boolean" - } - }, - "x-ms-client-name": "ProjectTrainedModel" - }, - "ConversationalAnalysisAuthoringProjectTrainedModels": { - "description": "Represents a list of retrieved trained models.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved jobs.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectTrainedModels" - }, - "ConversationalAnalysisAuthoringResourceMetadata": { - "description": "Represents metadata for the Azure resource..", - "required": [ - "azureResourceId", - "customDomain", - "region" - ], - "type": "object", - "properties": { - "azureResourceId": { - "description": "Represents the Azure resource ID.", - "type": "string" - }, - "customDomain": { - "description": "Represents the Azure resource custom domain.", - "type": "string" - }, - "region": { - "description": "Represents the Azure resource region.", - "type": "string" - } - }, - "x-ms-client-name": "ResourceMetadata" - }, - "ConversationalAnalysisAuthoringStringIndexType": { - "enum": [ - "Utf16CodeUnit" - ], - "type": "string", - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - }, - "x-ms-client-name": "StringIndexType" - }, - "ConversationalAnalysisAuthoringSubTrainingJobState": { - "description": "Represents the detailed state of a training sub-operation.", - "required": [ - "percentComplete", - "status" - ], - "type": "object", - "properties": { - "percentComplete": { - "format": "int32", - "description": "Represents progress percentage.", - "type": "integer" - }, - "startDateTime": { - "format": "date-time", - "description": "Represents the start date time.", - "type": "string" - }, - "endDateTime": { - "format": "date-time", - "description": "Represents the end date time.", - "type": "string" - }, - "status": { - "description": "Represents the status of the sub-operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" - } - }, - "x-ms-client-name": "SubTrainingJobState" - }, - "ConversationalAnalysisAuthoringSupportedLanguage": { - "description": "Represents a supported language.", - "required": [ - "languageName", - "languageCode" - ], - "type": "object", - "properties": { - "languageName": { - "description": "The language name.", - "type": "string" - }, - "languageCode": { - "description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "SupportedLanguage" - }, - "ConversationalAnalysisAuthoringSupportedLanguages": { - "description": "Represents a list of retrieved languages.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of the languages.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguage" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "SupportedLanguages" - }, - "ConversationalAnalysisAuthoringSwapDeploymentsOptions": { - "description": "Represents the options for swapping two deployments together.", - "required": [ - "firstDeploymentName", - "secondDeploymentName" - ], - "type": "object", - "properties": { - "firstDeploymentName": { - "description": "Represents the first deployment name.", - "type": "string" - }, - "secondDeploymentName": { - "description": "Represents the second deployment name.", - "type": "string" - } - }, - "x-ms-client-name": "SwapDeploymentsOptions" - }, - "ConversationalAnalysisAuthoringTrainingConfigVersion": { - "description": "Represents a training config version.", - "required": [ - "trainingConfigVersion", - "modelExpirationDate" - ], - "type": "object", - "properties": { - "trainingConfigVersion": { - "description": "Represents the version of the config.", - "type": "string" - }, - "modelExpirationDate": { - "format": "date", - "description": "Represents the training config version expiration date.", - "type": "string" - } - }, - "x-ms-client-name": "TrainingConfigVersion" - }, - "ConversationalAnalysisAuthoringTrainingConfigVersions": { - "description": "Represents a list of training config versions.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of the training config versions.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersion" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "TrainingConfigVersions" - }, - "ConversationalAnalysisAuthoringTrainingJobOptions": { - "description": "Represents the options for starting a new training job.", - "required": [ - "modelLabel", - "trainingMode" - ], - "type": "object", - "properties": { - "modelLabel": { - "description": "Represents the output model label.", - "type": "string" - }, - "trainingConfigVersion": { - "description": "Represents training config version. By default, \"latest\" value is used which uses the latest released training config version.", - "type": "string" - }, - "trainingMode": { - "description": "Represents the mode of the training operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" - }, - "evaluationOptions": { - "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" - } - }, - "x-ms-client-name": "TrainingJobOptions" - }, - "ConversationalAnalysisAuthoringTrainingJobResult": { - "description": "Represents the output of a training job.", - "required": [ - "modelLabel", - "trainingConfigVersion", - "trainingStatus" - ], - "type": "object", - "properties": { - "modelLabel": { - "description": "Represents trained model label.", - "type": "string" - }, - "trainingConfigVersion": { - "description": "Represents training config version.", - "type": "string" - }, - "trainingMode": { - "description": "Represents the mode of the training operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" - }, - "trainingStatus": { - "description": "Represents the model training status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" - }, - "evaluationStatus": { - "description": "Represents model evaluation status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" - }, - "estimatedEndDateTime": { - "format": "date-time", - "description": "Represents the estimated end date time for training and evaluation.", - "type": "string" - } - }, - "x-ms-client-name": "TrainingJobResult" - }, - "ConversationalAnalysisAuthoringTrainingJobs": { - "description": "Represents a list of retrieved training jobs.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of jobs.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "TrainingJobs" - }, - "ConversationalAnalysisAuthoringTrainingJobState": { - "description": "Represents the state of a training job.", - "required": [ - "result" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "properties": { - "result": { - "description": "Represents training tasks detailed result.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobResult" - } - }, - "x-ms-client-name": "TrainingJobState" - }, - "ConversationalAnalysisAuthoringTrainingMode": { - "enum": [ - "advanced", - "standard" - ], - "type": "string", - "x-ms-enum": { - "name": "TrainingMode", - "modelAsString": true, - "values": [ - { - "value": "advanced", - "description": "Trains using fine-tuned neural network transformer models. Can train multilingual projects." - }, - { - "value": "standard", - "description": "Faster training times for quicker iterations." - } - ] - }, - "x-ms-client-name": "TrainingMode" - }, - "ConversationalAnalysisAuthoringUnassignDeploymentResourcesOptions": { - "description": "Represents the options to unassign Azure resources from a project.", - "required": [ - "assignedResourceIds" - ], - "type": "object", - "properties": { - "assignedResourceIds": { - "description": "Represents the assigned resource IDs to be unassigned.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ms-client-name": "UnassignDeploymentResourcesOptions" - }, - "ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult": { - "description": "Represents the comparison between the expected and predicted entities for an utterance.", - "required": [ - "expectedEntities", - "predictedEntities" - ], - "type": "object", - "properties": { - "expectedEntities": { - "description": "Represents the expected entity labels.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" - } - }, - "predictedEntities": { - "description": "Represents the predicted entity labels.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" - } - } - }, - "x-ms-client-name": "UtteranceEntitiesEvaluationResult" - }, - "ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult": { - "description": "Represents the evaluation output of an entity label or prediction.", - "required": [ - "category", - "offset", - "length" - ], - "type": "object", - "properties": { - "category": { - "description": "Represents the entity category.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "Represents the entity offset index relative to the original text.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "Represents the entity length.", - "type": "integer" - } - }, - "x-ms-client-name": "UtteranceEntityEvaluationResult" - }, - "ConversationalAnalysisAuthoringUtteranceEvaluationResult": { - "description": "Represents the evaluation result for an utterance.", - "required": [ - "text", - "language", - "entitiesResult", - "intentsResult" - ], - "type": "object", - "properties": { - "text": { - "description": "Represents the utterance text.", - "type": "string" - }, - "language": { - "description": "Represents the utterance language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "entitiesResult": { - "description": "Represents the entities results for the utterance.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult" - }, - "intentsResult": { - "description": "Represents the intents results for the utterance.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult" - } - }, - "x-ms-client-name": "UtteranceEvaluationResult" - }, - "ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult": { - "description": "Represents the comparison between the expected and the predicted intent for an utterance.", - "required": [ - "expectedIntent", - "predictedIntent" - ], - "type": "object", - "properties": { - "expectedIntent": { - "description": "Represents the utterance's expected intent.", - "type": "string" - }, - "predictedIntent": { - "description": "Represents the utterance's predicted intent.", - "type": "string" - } - }, - "x-ms-client-name": "UtteranceIntentsEvaluationResult" - }, - "ConversationalAnalysisAuthoringWarning": { - "description": "Represents a warning that was encountered while executing the request.", - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "description": "The warning code.", - "type": "string" - }, - "message": { - "description": "The warning message.", - "type": "string" - } - }, - "x-ms-client-name": "Warning" - } - }, - "parameters": { - "ConversationalAnalysisAuthoringFormatQueryOptionalParameter": { - "in": "query", - "name": "format", - "description": "The format of the exported project file to use.", - "type": "string", - "enum": [ - "Conversation", - "Luis" - ], - "x-ms-enum": { - "name": "ExportedProjectFormat", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "Specifies the format for a conversational project." - }, - { - "value": "Luis", - "description": "Specifies the format for an application that was exported from LUIS." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "ConversationalAnalysisAuthoringStringIndexTypeQueryParameter": { - "in": "query", - "name": "stringIndexType", - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "required": true, - "type": "string", - "enum": [ - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "ConversationalAnalysisAuthoringJobIdPathParameter": { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ConversationalAnalysisAuthoringTrainedModelLabelPathParameter": { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model label.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ConversationalAnalysisAuthoringProjectKindQueryParameter": { - "in": "query", - "name": "projectKind", - "description": "The project kind.", - "required": true, - "type": "string", - "enum": [ - "Conversation", - "Orchestration", - "CustomConversationSummarization" - ], - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "A project to build natural language into apps, bots, and IoT devices." - }, - { - "value": "Orchestration", - "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." - }, - { - "value": "CustomConversationSummarization", - "description": "A project to build conversation summarization models which are able to summarize long conversations." - } - ] - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/analyzeconversations.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/analyzeconversations.json deleted file mode 100644 index c8c2c66da6d8..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/analyzeconversations.json +++ /dev/null @@ -1,2553 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Analyze Conversations", - "description": "The Language Service Conversations API is a suite of natural language processing (NLP) skills that you can use to analyze structured conversations (textual or spoken). The synchronous API in this suite accepts a request and mediates among multiple language projects, such as Language Understanding (LUIS) generally available, question answering, and conversational language understanding, and then calls the best candidate service to handle the request. Finally, it returns a response with the candidate service's response as a payload.\n\n In some cases, this API needs to forward requests and responses between the caller and an upstream service. The asynchronous APIs in this suite enable tasks like conversation summarization and detection of personally identifiable information (PII) in conversation.", - "version": "2022-10-01-preview" - }, - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) flows. When you pair them with [Azure role-based access control (RBAC)](https://docs.microsoft.com/azure/role-based-access-control/overview), you can use them to control access to Azure Maps REST APIs. You use RBAC to designate access to one or more Azure Maps resource accounts or subresources. You can grant any user, group, or service principal access via a built-in role or a custom role that consists of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling applications via objects that are capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. You can get this header from the [Azure Maps management API](https://aka.ms/amauthdetails).\n* \nThe authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique authorization URLs and Azure Active Directory configurations. \n* \nYou configure RBAC from the [Azure management plane](https://aka.ms/amrbac) via the Azure portal, PowerShell, the Azure CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration-based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports work, school, and guest accounts but does not support personal accounts.", - "scopes": { - "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" - } - }, - "apim_key": { - "type": "apiKey", - "description": "Subscription key for a language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://cognitiveservices.azure.com/.default" - ] - }, - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/:analyze-conversations": { - "post": { - "operationId": "ConversationAnalysis_AnalyzeConversation", - "description": "Analyzes the input conversation utterance.", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "A single conversation task to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeConversationTask" - }, - "required": true - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Conversation analysis response.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationTaskResult" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "description": "Error code for the specific error that occurred.", - "type": "string" - } - } - } - }, - "x-ms-examples": { - "Conversation project result": { - "$ref": "./examples/conversations/SuccessfulAnalyzeConversations.json" - }, - "Arbitration result": { - "$ref": "./examples/conversations/SuccessfulAnalyzeConversationsArbitration.json" - }, - "Orchestrator direct target result": { - "$ref": "./examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json" - } - } - } - }, - "/analyze-conversations/jobs": { - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "description": "Submit a collection of conversations for analysis. Specify one or more unique tasks to be executed.", - "operationId": "AnalyzeConversation_SubmitJob", - "summary": "Submit analysis job for conversations", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Collection of conversations to analyze and one or more tasks to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeConversationJobsInput" - }, - "required": true - } - ], - "responses": { - "202": { - "description": "A successful call results in an Operation-Location header that's used to check the status of the analysis job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Conversational PII Analysis Job Request": { - "$ref": "./examples/conversations/SuccessfulConversationPIISubmit.json" - }, - "Successful Conversation Summarization Analysis Job Request": { - "$ref": "./examples/conversations/SuccessfulConversationSummarySubmit.json" - }, - "Successful Conversation Summarization Task Submit": { - "$ref": "./examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json" - }, - "Successful Conversation Sentiment Analysis Job Request": { - "$ref": "./examples/conversations/SuccessfulConversationSentimentSubmit.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/analyze-conversations/jobs/{jobId}": { - "get": { - "produces": [ - "application/json" - ], - "description": "Get the status of an analysis job. A job can consist of one or more tasks. After all tasks succeed, the job transitions to the succeeded state and results are available for each task.", - "operationId": "AnalyzeConversation_JobStatus", - "summary": "Get analysis status and results", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/JobId" - }, - { - "$ref": "common.json#/parameters/ShowStats" - } - ], - "responses": { - "200": { - "description": "Analysis job status and metadata.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationJobState" - } - }, - "default": { - "description": "Error encountered.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Conversation PII Analysis Job Status Request": { - "$ref": "./examples/conversations/SuccessfulConversationPIITaskStatusRequest.json" - }, - "Successful Get Text Conversation Analysis Job Status Request": { - "$ref": "./examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json" - }, - "Successful Get Conversation Sentiment Analysis Job Status Request": { - "$ref": "./examples/conversations/SuccessfulConversationSentimentTaskStatusRequest.json" - }, - "Successful Get Conversation Summarization Result": { - "$ref": "./examples/conversations/SuccessfulConversationSummarizationTaskResult.json" - } - } - } - }, - "/analyze-conversations/jobs/{jobId}:cancel": { - "post": { - "produces": [ - "application/json" - ], - "description": "Cancel a long-running job for text analysis of conversations.", - "operationId": "AnalyzeConversation_CancelJob", - "summary": "Cancel a long-running Text Analysis conversations job", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/JobId" - } - ], - "responses": { - "202": { - "description": "The request to cancel a job has been received.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Job Delete Request": { - "$ref": "./examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json" - } - }, - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "AnalyzeConversationTaskKind": { - "type": "string", - "description": "Enumeration of supported conversation tasks.", - "enum": [ - "Conversation" - ], - "x-ms-enum": { - "name": "AnalyzeConversationTaskKind", - "modelAsString": true - } - }, - "AnalyzeConversationTaskResultsKind": { - "type": "string", - "description": "Enumeration of supported conversation task results.", - "enum": [ - "ConversationResult" - ], - "x-ms-enum": { - "name": "AnalyzeConversationTaskResultsKind", - "modelAsString": true - } - }, - "AnalyzeConversationTask": { - "type": "object", - "description": "Base class of a conversation input task.", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationTaskKind" - } - } - }, - "AnalyzeConversationTaskResult": { - "type": "object", - "description": "Base class of a conversation task result.", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationTaskResultsKind" - } - } - }, - "ConversationalTask": { - "type": "object", - "description": "Input for a custom conversation task.", - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationTask" - } - ], - "properties": { - "analysisInput": { - "$ref": "#/definitions/ConversationAnalysisOptions" - }, - "parameters": { - "$ref": "#/definitions/ConversationTaskParameters" - } - }, - "x-ms-discriminator-value": "Conversation", - "required": [ - "analysisInput", - "parameters" - ] - }, - "ConversationTaskParameters": { - "type": "object", - "description": "Input parameters necessary for a conversation task.", - "properties": { - "projectName": { - "type": "string", - "description": "Name of the project to use." - }, - "deploymentName": { - "type": "string", - "description": "Name of the deployment to use." - }, - "verbose": { - "type": "boolean", - "description": "If true, the service will return more detailed information in the response." - }, - "isLoggingEnabled": { - "type": "boolean", - "description": "If true, the service will keep the query for further review." - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - }, - "directTarget": { - "type": "string", - "description": "Name of a target project to forward the request to." - }, - "targetProjectParameters": { - "type": "object", - "description": "Dictionary that represents the parameters for each target project.", - "additionalProperties": { - "$ref": "#/definitions/AnalysisParameters" - } - } - }, - "required": [ - "projectName", - "deploymentName" - ] - }, - "ConversationalTaskResult": { - "description": "Results of a conversation task.", - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationTaskResult" - } - ], - "type": "object", - "properties": { - "result": { - "$ref": "#/definitions/AnalyzeConversationResult" - } - }, - "required": [ - "result" - ], - "x-ms-discriminator-value": "ConversationResult" - }, - "ConversationItemBase": { - "type": "object", - "description": "Abstract base for a user input formatted conversation (for example, text or transcript).", - "properties": { - "id": { - "description": "ID of a conversation item.", - "type": "string" - }, - "participantId": { - "description": "Participant ID of a conversation item.", - "type": "string" - }, - "language": { - "description": "Override language of a conversation item in BCP 47 language representation.", - "type": "string" - }, - "modality": { - "$ref": "#/definitions/Modality" - }, - "role": { - "type": "string", - "description": "Role of the participant.", - "enum": [ - "agent", - "customer", - "generic" - ], - "x-ms-enum": { - "name": "role", - "modelAsString": true - } - } - }, - "required": [ - "participantId", - "id" - ], - "additionalProperties": true - }, - "TextConversationItem": { - "type": "object", - "description": "Text modality of an input conversation.", - "allOf": [ - { - "$ref": "#/definitions/ConversationItemBase" - } - ], - "properties": { - "text": { - "description": "Text input.", - "type": "string" - } - }, - "required": [ - "text" - ] - }, - "ConversationAnalysisOptions": { - "type": "object", - "description": "ConversationItem input and its optional parameters.", - "required": [ - "conversationItem" - ], - "properties": { - "conversationItem": { - "$ref": "#/definitions/ConversationItemBase" - } - } - }, - "AnalysisParameters": { - "type": "object", - "description": "This is the parameter set of either the orchestration project itself or one of the target services.", - "required": [ - "targetProjectKind" - ], - "discriminator": "targetProjectKind", - "properties": { - "targetProjectKind": { - "type": "string", - "description": "Type of a target service.", - "enum": [ - "Luis", - "Conversation", - "QuestionAnswering", - "NonLinked" - ], - "x-ms-enum": { - "name": "targetProjectKind", - "modelAsString": true - } - }, - "apiVersion": { - "type": "string", - "description": "API version to use in calling a specific target service." - } - } - }, - "NoneLinkedTargetIntentResult": { - "type": "object", - "description": "Wrap-up of a non-linked intent response.", - "x-ms-discriminator-value": "NonLinked", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "$ref": "#/definitions/ConversationResult", - "description": "Actual response from a conversation project." - } - } - }, - "LuisParameters": { - "description": "This is a set of request parameters for LUIS generally available projects.", - "x-ms-discriminator-value": "Luis", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "query": { - "type": "string", - "maxLength": 500, - "description": "Utterance to predict." - }, - "callingOptions": { - "type": "object", - "description": "This customizes how the service calls LUIS generally available projects.", - "$ref": "#/definitions/LuisCallingOptions" - } - }, - "additionalProperties": true - }, - "LuisCallingOptions": { - "description": "This customizes how the service calls LUIS generally available projects.", - "type": "object", - "properties": { - "verbose": { - "description": "Enable a verbose response.", - "type": "boolean" - }, - "log": { - "description": "Save the log to add in training utterances later.", - "type": "boolean" - }, - "show-all-intents": { - "description": "Set to true to show all intents.", - "type": "boolean" - }, - "timezoneOffset": { - "type": "number", - "description": "Time zone offset for the location of the request." - }, - "spellCheck": { - "type": "boolean", - "description": "Enable spell checking." - }, - "bing-spell-check-subscription-key": { - "description": "Subscription key to use for enabling the Bing spell checker.", - "type": "string" - } - } - }, - "ConversationParameters": { - "type": "object", - "description": "This is a set of request parameters for customized conversation projects.", - "x-ms-discriminator-value": "Conversation", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "callingOptions": { - "type": "object", - "$ref": "#/definitions/ConversationCallingOptions" - } - } - }, - "ConversationCallingOptions": { - "type": "object", - "description": "Option to set to call a conversation project.", - "properties": { - "language": { - "description": "Language of the query in BCP 47 language representation.", - "type": "string" - }, - "verbose": { - "description": "If true, the service will return more detailed information.", - "type": "boolean" - }, - "isLoggingEnabled": { - "description": "If true, the query will be saved for customers to further review in authoring, to improve the model quality.", - "type": "boolean" - } - } - }, - "QuestionAnsweringParameters": { - "type": "object", - "description": "This is a set of request parameters for question-answering knowledge bases.", - "x-ms-discriminator-value": "QuestionAnswering", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "callingOptions": { - "description": "Options sent to a question-answering knowledge base.", - "$ref": "common.json#/definitions/AnswersOptions" - } - } - }, - "AnalyzeConversationResult": { - "type": "object", - "description": "Represents a conversation analysis response.", - "required": [ - "query", - "prediction" - ], - "properties": { - "query": { - "type": "string", - "description": "Conversation utterance given by the caller." - }, - "detectedLanguage": { - "type": "string", - "description": "System detected language for the query in BCP 47 language representation." - }, - "prediction": { - "description": "Prediction result of a conversation project.", - "$ref": "#/definitions/BasePrediction" - } - } - }, - "BasePrediction": { - "type": "object", - "description": "This is the base class of prediction.", - "required": [ - "projectKind" - ], - "discriminator": "projectKind", - "properties": { - "projectKind": { - "type": "string", - "description": "Type of the project.", - "enum": [ - "Conversation", - "Orchestration" - ], - "x-ms-enum": { - "name": "projectKind", - "modelAsString": true - } - }, - "topIntent": { - "type": "string", - "description": "Intent with the highest score." - } - } - }, - "OrchestrationPrediction": { - "type": "object", - "description": "This represents the prediction result of an orchestration project.", - "x-ms-discriminator-value": "Orchestration", - "required": [ - "intents" - ], - "allOf": [ - { - "$ref": "#/definitions/BasePrediction" - } - ], - "properties": { - "intents": { - "description": "Dictionary that contains all intents. A key is an intent name, and a value is its confidence score and target type. The top intent's value also contains the actual response from the target project.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TargetIntentResult" - } - } - } - }, - "TargetIntentResult": { - "type": "object", - "description": "This is the base class of an intent prediction.", - "discriminator": "targetProjectKind", - "required": [ - "confidenceScore", - "targetProjectKind" - ], - "properties": { - "targetProjectKind": { - "type": "string", - "description": "This discriminator property specifies the type of the target project that returns the response.", - "enum": [ - "Luis", - "Conversation", - "QuestionAnswering", - "NonLinked" - ], - "x-ms-enum": { - "name": "targetProjectKind", - "modelAsString": true - } - }, - "apiVersion": { - "type": "string", - "description": "API version that's used to call a target service." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidence", - "description": "Prediction score, which ranges from 0.0 to 1.0.", - "minimum": 0, - "maximum": 1 - } - } - }, - "ConversationTargetIntentResult": { - "type": "object", - "description": "Wrap-up of a conversation project response.", - "x-ms-discriminator-value": "Conversation", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "type": "object", - "$ref": "#/definitions/ConversationResult", - "description": "Actual response from a conversation project." - } - } - }, - "ConversationResult": { - "type": "object", - "description": "Response that a conversation project returned.", - "required": [ - "query" - ], - "properties": { - "query": { - "description": "The same query given in a request.", - "type": "string" - }, - "detectedLanguage": { - "description": "Detected language from the query in BCP 47 language representation.", - "type": "string" - }, - "prediction": { - "description": "Predicted result for the query.", - "$ref": "#/definitions/ConversationPrediction" - } - } - }, - "ConversationPrediction": { - "type": "object", - "description": "Represents the prediction section of a conversation project.", - "x-ms-discriminator-value": "Conversation", - "required": [ - "intents", - "entities" - ], - "allOf": [ - { - "$ref": "#/definitions/BasePrediction" - } - ], - "properties": { - "intents": { - "description": "Intent classification results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationIntent" - } - }, - "entities": { - "description": "Entity extraction results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationEntity" - } - } - } - }, - "ConversationIntent": { - "type": "object", - "description": "Intent classification result of a conversation project.", - "required": [ - "category", - "confidenceScore" - ], - "properties": { - "category": { - "description": "Predicted class.", - "type": "string" - }, - "confidenceScore": { - "format": "float", - "x-ms-client-name": "confidence", - "description": "Confidence score of the class, from 0.0 to 1.0.", - "type": "number", - "minimum": 0, - "maximum": 1 - } - } - }, - "ConversationEntity": { - "type": "object", - "description": "Entity extraction result of a conversation project.", - "required": [ - "category", - "text", - "offset", - "length", - "confidenceScore" - ], - "properties": { - "category": { - "description": "Entity category.", - "type": "string" - }, - "text": { - "description": "Predicted entity text.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "Starting index of this entity in the query.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "Length of the text.", - "type": "integer" - }, - "confidenceScore": { - "format": "float", - "x-ms-client-name": "confidence", - "description": "Entity confidence score.", - "type": "number" - }, - "resolutions": { - "description": "Collection of objects for entity resolution.", - "type": "array", - "items": { - "$ref": "#/definitions/BaseResolution" - } - }, - "extraInformation": { - "description": "Collection of objects for entity extra information.", - "type": "array", - "items": { - "$ref": "#/definitions/BaseExtraInformation" - } - } - } - }, - "BaseResolution": { - "description": "Abstract base class for entity resolutions.", - "type": "object", - "discriminator": "resolutionKind", - "properties": { - "resolutionKind": { - "description": "Kind of entity resolution object.", - "type": "string", - "enum": [ - "BooleanResolution", - "DateTimeResolution", - "NumberResolution", - "OrdinalResolution", - "SpeedResolution", - "WeightResolution", - "LengthResolution", - "VolumeResolution", - "AreaResolution", - "AgeResolution", - "InformationResolution", - "TemperatureResolution", - "CurrencyResolution", - "NumericRangeResolution", - "TemporalSpanResolution" - ], - "x-ms-enum": { - "name": "ResolutionKind", - "modelAsString": true - } - } - }, - "required": [ - "resolutionKind" - ] - }, - "QuantityResolution": { - "description": "Represents resolutions for quantities.", - "type": "object", - "properties": { - "value": { - "type": "number", - "format": "double", - "description": "Numeric value that the extracted text denotes." - } - }, - "required": [ - "value" - ] - }, - "AgeResolution": { - "description": "Represents the model for age entity resolution.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "AgeResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Year", - "Month", - "Week", - "Day" - ], - "x-ms-enum": { - "name": "AgeUnit", - "modelAsString": true - }, - "description": "Age unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "VolumeResolution": { - "description": "Represents the model for volume entity resolution.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "VolumeResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "CubicMeter", - "CubicCentimeter", - "CubicMillimeter", - "Hectoliter", - "Decaliter", - "Liter", - "Centiliter", - "Milliliter", - "CubicYard", - "CubicInch", - "CubicFoot", - "CubicMile", - "FluidOunce", - "Teaspoon", - "Tablespoon", - "Pint", - "Quart", - "Cup", - "Gill", - "Pinch", - "FluidDram", - "Barrel", - "Minim", - "Cord", - "Peck", - "Bushel", - "Hogshead" - ], - "x-ms-enum": { - "name": "VolumeUnit", - "modelAsString": true - }, - "description": "Volume unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "SpeedResolution": { - "description": "Represents the model for speed entity resolution.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "SpeedResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "MetersPerSecond", - "KilometersPerHour", - "KilometersPerMinute", - "KilometersPerSecond", - "MilesPerHour", - "Knot", - "FootPerSecond", - "FootPerMinute", - "YardsPerMinute", - "YardsPerSecond", - "MetersPerMillisecond", - "CentimetersPerMillisecond", - "KilometersPerMillisecond" - ], - "x-ms-enum": { - "name": "SpeedUnit", - "modelAsString": true - }, - "description": "Speed unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "AreaResolution": { - "description": "Represents the model for area entity resolution.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "AreaResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "SquareKilometer", - "SquareHectometer", - "SquareDecameter", - "SquareDecimeter", - "SquareMeter", - "SquareCentimeter", - "SquareMillimeter", - "SquareInch", - "SquareFoot", - "SquareMile", - "SquareYard", - "Acre" - ], - "x-ms-enum": { - "name": "AreaUnit", - "modelAsString": true - }, - "description": "Area unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "LengthResolution": { - "description": "Represents the model for length entity resolution.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "LengthResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Kilometer", - "Hectometer", - "Decameter", - "Meter", - "Decimeter", - "Centimeter", - "Millimeter", - "Micrometer", - "Nanometer", - "Picometer", - "Mile", - "Yard", - "Inch", - "Foot", - "LightYear", - "Pt" - ], - "x-ms-enum": { - "name": "LengthUnit", - "modelAsString": true - }, - "description": "Length unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "InformationResolution": { - "description": "Represents the model for information (data) entity resolution.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "InformationResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Bit", - "Kilobit", - "Megabit", - "Gigabit", - "Terabit", - "Petabit", - "Byte", - "Kilobyte", - "Megabyte", - "Gigabyte", - "Terabyte", - "Petabyte" - ], - "x-ms-enum": { - "name": "InformationUnit", - "modelAsString": true - }, - "description": "Information (data) unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "TemperatureResolution": { - "description": "Represents the model for temperature entity resolution.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "TemperatureResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Fahrenheit", - "Kelvin", - "Rankine", - "Celsius" - ], - "x-ms-enum": { - "name": "TemperatureUnit", - "modelAsString": true - }, - "description": "Temperature unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "WeightResolution": { - "description": "Represents the model for weight entity resolution.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "WeightResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Kilogram", - "Gram", - "Milligram", - "Gallon", - "MetricTon", - "Ton", - "Pound", - "Ounce", - "Grain", - "PennyWeight", - "LongTonBritish", - "ShortTonUS", - "ShortHundredWeightUS", - "Stone", - "Dram" - ], - "x-ms-enum": { - "name": "WeightUnit", - "modelAsString": true - }, - "description": "Weight unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "CurrencyResolution": { - "description": "Represents the model for currency entity resolution.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "CurrencyResolution", - "properties": { - "ISO4217": { - "type": "string", - "description": "Alphabetic code based on another ISO standard, ISO 3166, which lists the codes for country/region names. The first two letters of the ISO 4217 three-letter code are the same as the code for the country/region name. Where possible, the third letter of the ISO 4217 code corresponds to the first letter of the currency name." - }, - "value": { - "type": "number", - "format": "double", - "description": "Money amount captured in the extracted entity." - }, - "unit": { - "type": "string", - "description": "Unit of the amount captured in the extracted entity." - } - }, - "required": [ - "value", - "unit" - ] - }, - "BooleanResolution": { - "description": "Resolution for Boolean expressions.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "BooleanResolution", - "properties": { - "value": { - "type": "boolean" - } - }, - "required": [ - "value" - ] - }, - "DateTimeResolution": { - "description": "Resolution for date/time entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "DateTimeResolution", - "properties": { - "timex": { - "$ref": "#/definitions/TimeExpression" - }, - "dateTimeSubKind": { - "type": "string", - "enum": [ - "Time", - "Date", - "DateTime", - "Duration", - "Set" - ], - "x-ms-enum": { - "name": "DateTimeSubKind", - "modelAsString": true - }, - "description": "Date/time subkind." - }, - "value": { - "type": "string", - "description": "Actual time that the extracted text denotes." - }, - "modifier": { - "$ref": "#/definitions/TemporalModifier" - } - }, - "required": [ - "timex", - "dateTimeSubKind", - "value" - ] - }, - "NumberResolution": { - "description": "Resolution for numeric entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "NumberResolution", - "properties": { - "numberKind": { - "type": "string", - "enum": [ - "Integer", - "Decimal", - "Power", - "Fraction", - "Percent", - "Unspecified" - ], - "x-ms-enum": { - "name": "NumberKind", - "modelAsString": true - }, - "description": "Type of the extracted number entity." - }, - "value": { - "type": "number", - "format": "double", - "description": "Numeric representation of what the extracted text denotes." - } - }, - "required": [ - "numberKind", - "value" - ] - }, - "OrdinalResolution": { - "description": "Resolution for ordinal number entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "OrdinalResolution", - "properties": { - "offset": { - "type": "string", - "description": "Offset with respect to the reference (for example, offset = -1 in \"show me the second to last\")." - }, - "relativeTo": { - "type": "string", - "enum": [ - "Current", - "End", - "Start" - ], - "x-ms-enum": { - "name": "RelativeTo", - "modelAsString": true - }, - "description": "Reference point that the ordinal number denotes." - }, - "value": { - "type": "string", - "description": "Simple arithmetic expression that the ordinal number denotes." - } - }, - "required": [ - "offset", - "relativeTo", - "value" - ] - }, - "TemporalSpanResolution": { - "description": "Represents the resolution of a date and/or time span.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "TemporalSpanResolution", - "properties": { - "begin": { - "$ref": "#/definitions/TimeExpression" - }, - "end": { - "$ref": "#/definitions/TimeExpression" - }, - "duration": { - "type": "string", - "description": "Duration value whose formatting is based on ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)." - }, - "modifier": { - "$ref": "#/definitions/TemporalModifier" - }, - "timex": { - "type": "string", - "description": "Triplet that contains the beginning, the end, and the duration, all stated as ISO 8601 formatted strings." - } - } - }, - "NumericRangeResolution": { - "description": "Represents the resolution of numeric intervals.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "NumericRangeResolution", - "properties": { - "rangeKind": { - "type": "string", - "enum": [ - "Number", - "Speed", - "Weight", - "Length", - "Volume", - "Area", - "Age", - "Information", - "Temperature", - "Currency" - ], - "x-ms-enum": { - "name": "RangeKind", - "modelAsString": true - }, - "description": "Kind of range that the resolution object represents." - }, - "minimum": { - "type": "number", - "format": "double", - "description": "Beginning value of the interval." - }, - "maximum": { - "type": "number", - "format": "double", - "description": "Ending value of the interval." - } - }, - "required": [ - "rangeKind", - "minimum", - "maximum" - ] - }, - "TemporalModifier": { - "type": "string", - "description": "Modifier of a date/time instance.", - "enum": [ - "AfterApprox", - "Before", - "BeforeStart", - "Approx", - "ReferenceUndefined", - "SinceEnd", - "AfterMid", - "Start", - "After", - "BeforeEnd", - "Until", - "End", - "Less", - "Since", - "AfterStart", - "BeforeApprox", - "Mid", - "More" - ], - "x-ms-enum": { - "name": "TemporalModifier", - "modelAsString": true - } - }, - "TimeExpression": { - "type": "string", - "description": "Extended ISO 8601 date/time representation, as described in https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml." - }, - "BaseExtraInformation": { - "description": "Abstract base object for entity extra information.", - "type": "object", - "discriminator": "extraInformationKind", - "properties": { - "extraInformationKind": { - "description": "Kind of extra information object.", - "type": "string", - "enum": [ - "EntitySubtype", - "ListKey", - "RegexKey" - ], - "x-ms-enum": { - "name": "ExtraInformationKind", - "modelAsString": true - } - } - }, - "required": [ - "extraInformationKind" - ] - }, - "EntitySubtype": { - "description": "Concrete entity subtype model of extra information.", - "allOf": [ - { - "$ref": "#/definitions/BaseExtraInformation" - } - ], - "type": "object", - "x-ms-discriminator-value": "EntitySubtype", - "properties": { - "value": { - "type": "string", - "description": "Subtype of an extracted entity type." - } - } - }, - "ListKey": { - "description": "Kind of extra data for a list key.", - "allOf": [ - { - "$ref": "#/definitions/BaseExtraInformation" - } - ], - "type": "object", - "x-ms-discriminator-value": "ListKey", - "properties": { - "key": { - "type": "string", - "description": "Canonical form of the extracted entity." - } - } - }, - "RegexKey": { - "description": "Kind of extra data for a regex key.", - "allOf": [ - { - "$ref": "#/definitions/BaseExtraInformation" - } - ], - "type": "object", - "x-ms-discriminator-value": "RegexKey", - "properties": { - "key": { - "type": "string", - "description": "Key of the regex pattern that's used in extracting the entity." - }, - "regexPattern": { - "type": "string", - "description": ".NET regex pattern that's used in extracting the entity. For more information about .NET regular expressions, go to https://docs.microsoft.com/dotnet/standard/base-types/regular-expressions." - } - } - }, - "LuisTargetIntentResult": { - "type": "object", - "description": "Wrap-up of the LUIS generally available response.", - "x-ms-discriminator-value": "Luis", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "type": "object", - "description": "Actual response from a LUIS generally available application." - } - } - }, - "QuestionAnsweringTargetIntentResult": { - "type": "object", - "description": "Wrap-up of the question-answering knowledge base response.", - "x-ms-discriminator-value": "QuestionAnswering", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "description": "Generated answer by a question-answering knowledge base.", - "$ref": "common.json#/definitions/AnswersResult" - } - } - }, - "AnalyzeConversationJobsInput": { - "type": "object", - "properties": { - "displayName": { - "description": "Display name for the analysis job.", - "type": "string" - }, - "analysisInput": { - "$ref": "#/definitions/MultiLanguageConversationAnalysisInput" - }, - "tasks": { - "description": "Set of tasks to execute on the input conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeConversationLROTask" - } - } - }, - "required": [ - "analysisInput", - "tasks" - ] - }, - "AnalyzeConversationLROTask": { - "type": "object", - "description": "Base class for a long-running conversation input task.", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationLROTaskKind" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskIdentifier" - } - ] - }, - "AnalyzeConversationLROTaskKind": { - "type": "string", - "description": "Enumeration of supported analysis tasks on a collection of conversations.", - "enum": [ - "ConversationalPIITask", - "ConversationalSummarizationTask", - "ConversationalSentimentTask" - ], - "x-ms-enum": { - "name": "AnalyzeConversationLROTaskKind", - "modelAsString": true - } - }, - "AnalyzeConversationResultsKind": { - "type": "string", - "description": "Enumeration of results for supported conversation analysis tasks.", - "enum": [ - "ConversationalPIIResults", - "ConversationalSummarizationResults", - "ConversationalSentimentResults" - ], - "x-ms-enum": { - "name": "AnalyzeConversationResultsKind", - "modelAsString": true - } - }, - "AnalyzeConversationPIITask": { - "type": "object", - "description": "Task definition for a PII redaction in conversations.", - "properties": { - "parameters": { - "$ref": "#/definitions/ConversationPIITaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationLROTask" - } - ], - "x-ms-discriminator-value": "ConversationalPIITask" - }, - "ConversationPIIItemResult": { - "type": "object", - "required": [ - "id", - "redactedContent", - "entities" - ], - "properties": { - "id": { - "type": "string" - }, - "redactedContent": { - "type": "object", - "$ref": "#/definitions/RedactedTranscriptContent" - }, - "entities": { - "type": "array", - "items": { - "$ref": "#/definitions/Entity" - } - } - } - }, - "MultiLanguageConversationAnalysisInput": { - "type": "object", - "required": [ - "conversations" - ], - "properties": { - "conversations": { - "type": "array", - "items": { - "$ref": "#/definitions/Conversation" - } - } - } - }, - "Conversation": { - "type": "object", - "description": "Complete ordered set of utterances (spoken or written) by one or more speakers to be used for analysis.", - "discriminator": "modality", - "required": [ - "id", - "language", - "modality" - ], - "properties": { - "id": { - "description": "Unique identifier for the conversation.", - "type": "string" - }, - "language": { - "description": "Language of the conversation item in BCP-47 format.", - "type": "string" - }, - "modality": { - "$ref": "#/definitions/Modality" - }, - "domain": { - "$ref": "#/definitions/ConversationDomain" - } - } - }, - "Modality": { - "type": "string", - "description": "Enumeration of supported conversational modalities.", - "enum": [ - "transcript", - "text" - ], - "x-ms-enum": { - "name": "InputModality", - "modelAsString": true - } - }, - "ConversationDomain": { - "type": "string", - "description": "Enumeration of supported conversational domains.", - "enum": [ - "finance", - "healthcare", - "generic" - ], - "x-ms-enum": { - "name": "ConversationDomain", - "modelAsString": true - } - }, - "TextConversation": { - "type": "object", - "x-ms-discriminator-value": "text", - "required": [ - "conversationItems" - ], - "allOf": [ - { - "$ref": "#/definitions/Conversation" - } - ], - "properties": { - "conversationItems": { - "description": "Ordered list of text conversation items in the conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/TextConversationItem" - } - } - } - }, - "TranscriptConversation": { - "type": "object", - "x-ms-discriminator-value": "transcript", - "required": [ - "conversationItems" - ], - "allOf": [ - { - "$ref": "#/definitions/Conversation" - } - ], - "properties": { - "conversationItems": { - "description": "Ordered list of transcript conversation items in the conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/TranscriptConversationItem" - } - } - } - }, - "TranscriptConversationItem": { - "type": "object", - "description": "Additional properties for supporting transcript conversation.", - "required": [ - "text", - "lexical", - "itn", - "maskedItn" - ], - "allOf": [ - { - "$ref": "#/definitions/ConversationItemBase" - } - ], - "properties": { - "itn": { - "type": "string", - "description": "Inverse text normalization (ITN) representation of input. The inverse-text-normalized form is the recognized text from Microsoft's speech-to-text API, with phone numbers, numbers, abbreviations, and other transformations applied." - }, - "maskedItn": { - "type": "string", - "description": "Inverse-text-normalized format with profanity masking applied." - }, - "text": { - "type": "string", - "description": "Display form of the recognized text from the speech-to-text API, with punctuation and capitalization added." - }, - "lexical": { - "type": "string", - "description": "Lexical form of the recognized text from the speech-to-text API, with the actual words recognized." - }, - "wordLevelTimings": { - "type": "array", - "description": "List of word-level audio timing information.", - "items": { - "$ref": "#/definitions/WordLevelTiming" - } - }, - "conversationItemLevelTiming": { - "description": "Audio timing at the conversation item level. This still can help with AI quality if word-level audio timings are not available.", - "$ref": "#/definitions/ConversationItemLevelTiming" - } - } - }, - "RedactedTranscriptContent": { - "type": "object", - "description": "Transcript content response that the service generates, with all necessary personally identifiable information redacted.", - "properties": { - "itn": { - "type": "string", - "description": "Redacted output for input in inverse-text-normalized format." - }, - "maskedItn": { - "type": "string", - "description": "Redacted output for input in masked inverse-text-normalized format." - }, - "text": { - "type": "string", - "description": "Redacted output for input in text (Microsoft's speech-to-text 'display') format." - }, - "lexical": { - "type": "string", - "description": "Redacted output for input in lexical format." - }, - "audioTimings": { - "type": "array", - "description": "List of redacted audio segments.", - "items": { - "$ref": "#/definitions/AudioTiming" - } - } - } - }, - "WordLevelTiming": { - "type": "object", - "description": "Word-level timing information that the speech-to-text API generates. The words in this object should have 1:1 correspondence with the lexical input to allow for audio redaction.", - "properties": { - "word": { - "type": "string", - "description": "Recognized word." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AudioTiming" - } - ] - }, - "AudioTiming": { - "type": "object", - "description": "Audio timing information.", - "properties": { - "offset": { - "description": "Offset from the start of speech audio, in ticks. 1 tick = 100 nanoseconds.", - "type": "integer", - "format": "int64" - }, - "duration": { - "description": "Duration of word articulation, in ticks. 1 tick = 100 nanoseconds.", - "type": "integer", - "format": "int64" - } - } - }, - "Entity": { - "type": "object", - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ], - "properties": { - "text": { - "type": "string", - "description": "Entity text as it appears in the request." - }, - "category": { - "type": "string", - "description": "Entity type." - }, - "subcategory": { - "type": "string", - "description": "Entity subtype." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text. Use of different stringIndexType values can affect the offset that's returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text. Use of different stringIndexType values can affect the length that's returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 for the extracted entity." - } - } - }, - "AnalyzeConversationConversationPIIResult": { - "type": "object", - "description": "Result from the PII detection and redaction operation that's performed on a list of conversations.", - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationJobResult" - } - ], - "properties": { - "results": { - "$ref": "#/definitions/ConversationPIIResults" - } - }, - "required": [ - "results" - ], - "x-ms-discriminator-value": "ConversationalPIIResults" - }, - "ConversationPIIResults": { - "type": "object", - "description": "Result from the PII detection and redaction operation for each conversation.", - "required": [ - "conversations" - ], - "properties": { - "conversations": { - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalPIIResultWithResultBase" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ] - }, - "ConversationalPIIResultWithResultBase": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationPIIResult" - }, - { - "$ref": "#/definitions/ConversationResultBase" - } - ] - }, - "ConversationPIIResult": { - "type": "object", - "description": "Result from the PII detection and redaction operation for each conversation.", - "required": [ - "conversationItems" - ], - "properties": { - "conversationItems": { - "description": "Enumeration of PII detection and redaction operation results for all the conversation items in a conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationPIIItemResult" - } - } - } - }, - "ConversationPIITaskParameters": { - "type": "object", - "description": "Supported parameters for a conversational PII detection and redaction task.", - "properties": { - "piiCategories": { - "$ref": "#/definitions/ConversationPIICategories" - }, - "includeAudioRedaction": { - "type": "boolean", - "description": "Flag to indicate if audio redaction is requested. By default, audio redaction won't be performed.", - "default": false - }, - "redactionSource": { - "type": "string", - "description": "For transcript conversations, this parameter provides information about which content type (ITN, text, lexical, masked ITN) should be used for entity detection. The details of the detected entities - like the offset, the length, and the text itself - will correspond to the text type selected here.", - "$ref": "#/definitions/TranscriptContentType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "ConversationPIICategories": { - "description": "Describes the PII categories to return for detection. If it's not provided, default categories that vary with the language will be returned.", - "items": { - "type": "string", - "x-ms-enum": { - "name": "ConversationPIICategory", - "modelAsString": true - }, - "enum": [ - "Address", - "CreditCardNumber", - "Email", - "Name", - "NumericIdentifier", - "PhoneNumber", - "USSocialSecurityNumber", - "Miscellaneous", - "All", - "Default" - ] - }, - "type": "array", - "uniqueItems": true - }, - "TranscriptContentType": { - "type": "string", - "description": "Enumeration of supported transcript content types.", - "enum": [ - "lexical", - "itn", - "maskedItn", - "text" - ], - "x-ms-enum": { - "name": "TranscriptContentType", - "modelAsString": true - } - }, - "AnalyzeConversationSummarizationTask": { - "type": "object", - "description": "Task definition for conversational summarization.", - "properties": { - "parameters": { - "$ref": "#/definitions/ConversationSummarizationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationLROTask" - } - ], - "x-ms-discriminator-value": "ConversationalSummarizationTask" - }, - "ConversationSummarizationTaskParameters": { - "type": "object", - "description": "Supported parameters for a conversational summarization task.", - "required": [ - "summaryAspects" - ], - "properties": { - "summaryAspects": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "issue", - "resolution", - "chapterTitle", - "narrative" - ], - "x-ms-enum": { - "name": "SummaryAspect", - "modelAsString": true, - "values": [ - { - "value": "issue", - "description": "Summary of issues in transcripts of web chats and service calls between customer-service agents and customers." - }, - { - "value": "resolution", - "description": "Summary of resolutions in transcripts of web chats and service calls between customer-service agents and customers." - }, - { - "value": "chapterTitle", - "description": "Chapter title of any conversation. It's usually one phrase or several phrases naturally combined. Long conversations tend to have more chapters. You can find the chapter boundary from the summary context." - }, - { - "value": "narrative", - "description": "Generic narrative summary of any conversation. It generally converts the conversational language into formal written language, compresses the text length, and keeps the salient information." - } - ] - } - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - }, - { - "$ref": "common.json#/definitions/AbstractiveSummarizationTaskParametersBase" - } - ] - }, - "AnalyzeConversationSummarizationResult": { - "type": "object", - "description": "Result for the summarization task on the conversation.", - "properties": { - "results": { - "$ref": "#/definitions/SummaryResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationJobResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "ConversationalSummarizationResults" - }, - "SummaryResult": { - "type": "object", - "required": [ - "conversations" - ], - "properties": { - "conversations": { - "type": "array", - "items": { - "$ref": "#/definitions/ConversationsSummaryResult" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ] - }, - "ConversationsSummaryResult": { - "type": "object", - "required": [ - "summaries" - ], - "properties": { - "summaries": { - "type": "array", - "items": { - "$ref": "#/definitions/SummaryResultItem" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/ConversationResultBase" - } - ] - }, - "SummaryResultItem": { - "type": "object", - "properties": { - "aspect": { - "type": "string" - }, - "text": { - "type": "string" - }, - "contexts": { - "type": "array", - "description": "Context list of the summary.", - "items": { - "$ref": "#/definitions/ItemizedSummaryContext" - } - } - }, - "required": [ - "aspect", - "text" - ] - }, - "AnalyzeConversationalSentimentTask": { - "type": "object", - "description": "Task definition for a sentiment analysis in conversations.", - "properties": { - "parameters": { - "$ref": "#/definitions/ConversationalSentimentTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationLROTask" - } - ], - "x-ms-discriminator-value": "ConversationalSentimentTask" - }, - "ConversationalSentimentTaskParameters": { - "type": "object", - "description": "Supported parameters for a conversational sentiment analysis task.", - "properties": { - "predictionSource": { - "type": "string", - "description": "For transcript conversations, this parameter provides information about which content type should be used for sentiment analysis. The details of the sentiment analysis - like the offset, the length, and the text itself - will correspond to the text type selected here.", - "$ref": "#/definitions/TranscriptContentType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "AnalyzeConversationSentimentResult": { - "type": "object", - "description": "Result from the sentiment analysis operation performed on a list of conversations.", - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationJobResult" - } - ], - "properties": { - "results": { - "$ref": "#/definitions/ConversationSentimentResults" - } - }, - "required": [ - "results" - ], - "x-ms-discriminator-value": "ConversationalSentimentResults" - }, - "ConversationSentimentResults": { - "type": "object", - "description": "Result from the sentiment analysis operation for each conversation.", - "required": [ - "conversations" - ], - "properties": { - "conversations": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "#/definitions/ConversationSentimentResult" - }, - { - "$ref": "#/definitions/ConversationResultBase" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ] - }, - "ConversationSentimentResult": { - "type": "object", - "description": "Result from the sentiment analysis operation for each conversation item.", - "required": [ - "conversationItems" - ], - "properties": { - "conversationItems": { - "description": "Enumeration of sentiment operation results for all the conversation items in a conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationSentimentItemResult" - } - } - } - }, - "ConversationSentimentItemResult": { - "type": "object", - "required": [ - "id", - "participantId", - "sentiment", - "confidenceScores" - ], - "properties": { - "id": { - "description": "Identifier for the conversation item.", - "type": "string" - }, - "participantId": { - "description": "Identifier for the speaker.", - "type": "string" - }, - "sentiment": { - "$ref": "common.json#/definitions/Sentiment" - }, - "confidenceScores": { - "type": "object", - "$ref": "common.json#/definitions/SentimentConfidenceScores" - } - } - }, - "AnalyzeConversationJobState": { - "description": "Contains the status of the submitted job for analyzing a conversation, along with related statistics.", - "allOf": [ - { - "$ref": "common.json#/definitions/JobState" - }, - { - "$ref": "#/definitions/ConversationTasksState" - }, - { - "$ref": "#/definitions/AnalyzeConversationJobStatistics" - } - ] - }, - "AnalyzeConversationJobStatistics": { - "description": "Contains the statistics for the submitted job.", - "properties": { - "statistics": { - "$ref": "#/definitions/ConversationRequestStatistics" - } - }, - "type": "object" - }, - "ConversationTasksState": { - "description": "Contains the state for the tasks that are being executed as part of the submitted job for analyzing a conversation.", - "properties": { - "tasks": { - "properties": { - "completed": { - "description": "Count of tasks that finished successfully.", - "type": "integer", - "format": "int32" - }, - "failed": { - "description": "Count of tasks that failed.", - "type": "integer", - "format": "int32" - }, - "inProgress": { - "description": "Count of tasks that are currently in progress.", - "type": "integer", - "format": "int32" - }, - "total": { - "description": "Total count of tasks submitted as part of the job.", - "type": "integer", - "format": "int32" - }, - "items": { - "description": "List of results from tasks (if available).", - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeConversationJobResult" - } - } - }, - "required": [ - "total", - "completed", - "failed", - "inProgress" - ], - "type": "object" - } - }, - "required": [ - "tasks" - ], - "type": "object" - }, - "AnalyzeConversationJobResult": { - "type": "object", - "description": "Container for results of all tasks in the conversation job.", - "discriminator": "kind", - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationResultsKind" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskState" - }, - { - "$ref": "common.json#/definitions/TaskIdentifier" - } - ], - "required": [ - "kind" - ] - }, - "ConversationResultBase": { - "type": "object", - "description": "Shared attributes for all conversational task results.", - "required": [ - "id", - "warnings" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique, non-empty conversation identifier." - }, - "warnings": { - "type": "array", - "description": "Warnings encountered in processing the document.", - "items": { - "$ref": "common.json#/definitions/InputWarning" - } - }, - "statistics": { - "$ref": "#/definitions/ConversationStatistics" - } - } - }, - "ConversationStatistics": { - "type": "object", - "description": "If showStats=true was specified in the request, this field contains information about the conversation payload.", - "required": [ - "transactionsCount" - ], - "properties": { - "transactionsCount": { - "type": "integer", - "format": "int32", - "description": "Number of text units for the request." - } - } - }, - "ConversationRequestStatistics": { - "type": "object", - "description": "if showStats=true was specified in the request, this field contains information about the request payload.", - "required": [ - "conversationsCount", - "validConversationsCount", - "erroneousConversationsCount" - ], - "properties": { - "conversationsCount": { - "type": "integer", - "format": "int32", - "description": "Number of conversations submitted in the request." - }, - "validConversationsCount": { - "type": "integer", - "format": "int32", - "description": "Number of conversation documents. This excludes documents that are empty, over the size limit, or in unsupported languages." - }, - "erroneousConversationsCount": { - "type": "integer", - "format": "int32", - "description": "Number of invalid documents. This includes documents that are empty, over the size limit, or in unsupported languages." - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/RequestStatistics" - } - ] - }, - "ConversationItemLevelTiming": { - "type": "object", - "description": "Audio timing at the conversation item level.", - "allOf": [ - { - "$ref": "#/definitions/AudioTiming" - } - ] - }, - "ItemizedSummaryContext": { - "type": "object", - "description": "Context of the summary with a conversation item ID.", - "required": [ - "conversationItemId" - ], - "properties": { - "conversationItemId": { - "type": "string", - "description": "Reference to the ID of ConversationItem." - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/SummaryContext" - } - ] - } - }, - "parameters": { - "ConversationAnalysisOptions": { - "name": "ConversationAnalysisOptions", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationAnalysisOptions" - }, - "description": "POST body of the request.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/analyzetext-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/analyzetext-authoring.json deleted file mode 100644 index 208a745a9982..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/analyzetext-authoring.json +++ /dev/null @@ -1,3802 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Analyze Text Authoring", - "version": "2022-10-01-preview", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview." - }, - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" - } - }, - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://cognitiveservices.azure.com/.default" - ] - }, - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/authoring/analyze-text/projects": { - "get": { - "description": "Lists the existing projects.", - "operationId": "TextAnalysisAuthoring_ListProjects", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of projects.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectsMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Projects": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListProjects.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/{projectName}": { - "patch": { - "description": "Creates a new project or updates an existing one.", - "operationId": "TextAnalysisAuthoring_CreateProject", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The project parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringCreateProjectOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of the updated project, if it already exists.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" - } - }, - "201": { - "description": "The metadata of the created project.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Create Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulCreateProject.json" - } - } - }, - "get": { - "description": "Gets the details of a project.", - "operationId": "TextAnalysisAuthoring_GetProject", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metadata of the project.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetProject.json" - } - } - }, - "delete": { - "description": "Deletes a project.", - "operationId": "TextAnalysisAuthoring_DeleteProject", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/:export": { - "post": { - "description": "Triggers a job to export a project's data.", - "operationId": "TextAnalysisAuthoring_Export", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringStringIndexTypeQueryParameter" - }, - { - "in": "query", - "name": "assetKind", - "description": "Kind of asset to export.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "in": "query", - "name": "trainedModelLabel", - "description": "Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Export Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulExportProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/:import": { - "post": { - "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", - "operationId": "TextAnalysisAuthoring_Import", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The project data to import.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProject" - } - }, - { - "in": "header", - "name": "format", - "description": "The format of the project to import. The currently supported formats are json and aml formats. If not provided, the default is set to json.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Import Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulImportProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/:train": { - "post": { - "description": "Triggers a training job for a project.", - "operationId": "TextAnalysisAuthoring_Train", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The training input parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Train Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulTrainProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments": { - "get": { - "description": "Lists the deployments belonging to a project.", - "operationId": "TextAnalysisAuthoring_ListDeployments", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all deployments.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployments" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Deployments": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListDeployments.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/:swap": { - "post": { - "description": "Swaps two existing deployments with each other.", - "operationId": "TextAnalysisAuthoring_SwapDeployments", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The job object to swap two deployments.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringSwapDeploymentsOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Swap Deployments": { - "$ref": "./examples/analyzetext-authoring/SuccessfulSwapDeployments.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}": { - "get": { - "description": "Gets the details of a deployment.", - "operationId": "TextAnalysisAuthoring_GetDeployment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The Deployment info.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployment" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Deployment": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetDeployment.json" - } - } - }, - "put": { - "description": "Creates a new deployment or replaces an existing one.", - "operationId": "TextAnalysisAuthoring_DeployProject", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The new deployment info.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringCreateDeploymentOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Deploy Project": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeployProject.json" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "description": "Deletes a project deployment.", - "operationId": "TextAnalysisAuthoring_DeleteDeployment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Deployment": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteDeployment.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources": { - "post": { - "description": "Deletes a project deployment from the specified assigned resources.", - "operationId": "TextAnalysisAuthoring_DeleteDeploymentFromResources", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The options for deleting the deployment.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringDeleteDeploymentOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Deployment": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteDeploymentFromResources.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing delete deployment from specific resources job.", - "operationId": "TextAnalysisAuthoring_GetDeploymentDeleteFromResourcesStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The deployment job result.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringDeploymentJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Deployment Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing deployment job.", - "operationId": "TextAnalysisAuthoring_GetDeploymentStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The deployment job result.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringDeploymentJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Delete Deployment From Resources Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetDeleteDeploymentFromResourcesStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing swap deployment job.", - "operationId": "TextAnalysisAuthoring_GetSwapDeploymentsStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The swap deployment job result.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringDeploymentJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Swap Deployments Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}": { - "get": { - "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", - "operationId": "TextAnalysisAuthoring_GetExportStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The status of the long running operation.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringExportProjectJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Export Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetExportStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}": { - "get": { - "description": "Gets the status for an import.", - "operationId": "TextAnalysisAuthoring_GetImportStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The details of the long running operation.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringImportProjectJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Import Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetImportStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models": { - "get": { - "description": "Lists the trained models belonging to a project.", - "operationId": "TextAnalysisAuthoring_ListTrainedModels", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all trained models.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModels" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Models": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListModels.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}": { - "get": { - "description": "Gets the details of a trained model.", - "operationId": "TextAnalysisAuthoring_GetTrainedModel", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Trained model info", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModel" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetModel.json" - } - } - }, - "delete": { - "description": "Deletes an existing trained model.", - "operationId": "TextAnalysisAuthoring_DeleteTrainedModel", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "204": { - "description": "Deleted successfully." - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Delete Model": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteModel.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot": { - "post": { - "description": "Restores the snapshot of this trained model to be the current working directory of the project.", - "operationId": "TextAnalysisAuthoring_LoadSnapshot", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results in loading the working directory with the snapshot of the model provided.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Load Snapshot": { - "$ref": "./examples/analyzetext-authoring/SuccessfulLoadSnapshot.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { - "get": { - "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", - "operationId": "TextAnalysisAuthoring_GetModelEvaluationResults", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringStringIndexTypeQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of the evaluation results.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationResults" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model Evaluation": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { - "get": { - "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", - "operationId": "TextAnalysisAuthoring_GetModelEvaluationSummary", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all evaluation results.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Model Evaluation Summary": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}": { - "get": { - "description": "Gets the status for loading a snapshot.", - "operationId": "TextAnalysisAuthoring_GetLoadSnapshotStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The details of the long running operation.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringLoadSnapshotJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Load Snapshot Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetLoadSnapshotStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/resources": { - "get": { - "description": "Lists the deployments resources assigned to the project.", - "operationId": "TextAnalysisAuthoring_ListDeploymentResources", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The assigned deployment resources.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringAssignedDeploymentResources" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Deployment Resources": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListDeploymentResources.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/resources/:assign": { - "post": { - "description": "Assign new Azure resources to a project to allow deploying new deployments to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory", - "operationId": "TextAnalysisAuthoring_AssignDeploymentResources", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The new project resources info.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringAssignDeploymentResourcesOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Assign Deployment Resources": { - "$ref": "./examples/analyzetext-authoring/SuccessfulAssignDeploymentResources.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/resources/:unassign": { - "post": { - "description": "Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them.", - "operationId": "TextAnalysisAuthoring_UnassignDeploymentResources", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The info for the deployment resources to be deleted.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringUnassignDeploymentResourcesOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Unassign Deployment Resources": { - "$ref": "./examples/analyzetext-authoring/SuccessfulUnassignDeploymentResources.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/resources/assign/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing assign deployment resources job.", - "operationId": "TextAnalysisAuthoring_GetAssignDeploymentResourcesStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The assign deployment resources job result.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringDeploymentResourcesJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Assign Deployment Resources Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/resources/unassign/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing unassign deployment resources job.", - "operationId": "TextAnalysisAuthoring_GetUnassignDeploymentResourcesStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The unassign deployment resources job result.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringDeploymentResourcesJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Unassign Deployment Resources Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/train/jobs": { - "get": { - "description": "Lists the non-expired training jobs created for a project.", - "operationId": "TextAnalysisAuthoring_ListTrainingJobs", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of the training jobs.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobs" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Training Jobs": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListTrainingJobs.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}": { - "get": { - "description": "Gets the status for a training job.", - "operationId": "TextAnalysisAuthoring_GetTrainingStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The training job result.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Train Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetTrainStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}/:cancel": { - "post": { - "description": "Triggers a cancellation for a running training job.", - "operationId": "TextAnalysisAuthoring_CancelTrainingJob", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the job cancellation.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Cancel Training Job": { - "$ref": "./examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/global/deletion-jobs/{jobId}": { - "get": { - "description": "Gets the status for a project deletion job.", - "operationId": "TextAnalysisAuthoring_GetProjectDeletionStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The project deletion job result.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectDeletionJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Project Deletion Status": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/global/deployments/resources": { - "get": { - "description": "Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.", - "operationId": "TextAnalysisAuthoring_ListAssignedResourceDeployments", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The assigned deployments metadata for the resource.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringAssignedResourceDeploymentsMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful List Assigned Resource Deployments": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListAssignedResourceDeployments.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/global/languages": { - "get": { - "description": "Lists the supported languages.", - "operationId": "TextAnalysisAuthoring_GetSupportedLanguages", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/TextAnalysisAuthoringProjectKindQueryOptionalParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of supported languages.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringSupportedLanguages" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Supported Languages": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - }, - "/authoring/analyze-text/projects/global/training-config-versions": { - "get": { - "description": "Lists the support training config version for a given project type.", - "operationId": "TextAnalysisAuthoring_ListTrainingConfigVersions", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/TextAnalysisAuthoringProjectKindQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all trained models.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingConfigVersions" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Supported Training Config Versions": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - } - } - } - }, - "definitions": { - "TextAnalysisAuthoringAssignDeploymentResourcesOptions": { - "description": "Represents the options for assigning Azure resources to a project.", - "required": [ - "resourcesMetadata" - ], - "type": "object", - "properties": { - "resourcesMetadata": { - "description": "Represents the metadata for the resources to be assigned.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringResourceMetadata" - } - } - }, - "x-ms-client-name": "AssignDeploymentResourcesOptions" - }, - "TextAnalysisAuthoringAssignedDeploymentResource": { - "description": "Represents the assigned deployment resource.", - "required": [ - "azureResourceId", - "region" - ], - "type": "object", - "properties": { - "azureResourceId": { - "description": "The resource ID.", - "type": "string" - }, - "region": { - "description": "The resource region.", - "type": "string" - } - }, - "x-ms-client-name": "AssignedDeploymentResource" - }, - "TextAnalysisAuthoringAssignedDeploymentResources": { - "description": "Represents the assigned deployment resources.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of assigned deployment resources.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringAssignedDeploymentResource" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "AssignedDeploymentResources" - }, - "TextAnalysisAuthoringAssignedProjectDeploymentMetadata": { - "description": "Represents the metadata for an assigned deployment", - "required": [ - "deploymentName", - "lastDeployedDateTime", - "deploymentExpirationDate" - ], - "type": "object", - "properties": { - "deploymentName": { - "description": "Represents the deployment name.", - "type": "string" - }, - "lastDeployedDateTime": { - "format": "date-time", - "description": "Represents deployment last deployed time.", - "type": "string" - }, - "deploymentExpirationDate": { - "format": "date", - "description": "Represents deployment expiration date in the runtime.", - "type": "string" - } - }, - "x-ms-client-name": "AssignedProjectDeploymentMetadata" - }, - "TextAnalysisAuthoringAssignedProjectDeploymentsMetadata": { - "description": "Represents the metadata for assigned deployments for a project.", - "required": [ - "projectName", - "deploymentsMetadata" - ], - "type": "object", - "properties": { - "projectName": { - "description": "Represents the project name.", - "type": "string" - }, - "deploymentsMetadata": { - "description": "Represents the resource region.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringAssignedProjectDeploymentMetadata" - } - } - }, - "x-ms-client-name": "AssignedProjectDeploymentsMetadata" - }, - "TextAnalysisAuthoringAssignedResourceDeploymentsMetadata": { - "description": "Represents the metadata for deployments assigned to a resource.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved assigned project deployments.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringAssignedProjectDeploymentsMetadata" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "AssignedResourceDeploymentsMetadata" - }, - "TextAnalysisAuthoringConfusionMatrix": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixRow" - }, - "x-ms-client-name": "ConfusionMatrix" - }, - "TextAnalysisAuthoringConfusionMatrixCell": { - "description": "Represents a cell in a confusion matrix.", - "required": [ - "normalizedValue", - "rawValue" - ], - "type": "object", - "properties": { - "normalizedValue": { - "format": "float", - "description": "Represents normalized value in percentages.", - "type": "number" - }, - "rawValue": { - "format": "float", - "description": "Represents raw value.", - "type": "number" - } - }, - "x-ms-client-name": "ConfusionMatrixCell" - }, - "TextAnalysisAuthoringConfusionMatrixRow": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixCell" - }, - "x-ms-client-name": "ConfusionMatrixRow" - }, - "TextAnalysisAuthoringCreateDeploymentOptions": { - "description": "Represents the options for creating or updating a project deployment.", - "required": [ - "trainedModelLabel" - ], - "type": "object", - "properties": { - "trainedModelLabel": { - "description": "Represents the trained model label.", - "type": "string" - }, - "assignedResourceIds": { - "description": "Represents the resource IDs to be assigned to the deployment.\n If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ms-client-name": "CreateDeploymentOptions" - }, - "TextAnalysisAuthoringCreateProjectOptions": { - "description": "Represents the options used to create or update a project.", - "required": [ - "projectKind", - "storageInputContainerName", - "projectName", - "language" - ], - "type": "object", - "properties": { - "projectKind": { - "description": "The project kind.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" - }, - "storageInputContainerName": { - "description": "The storage container name.", - "type": "string" - }, - "settings": { - "description": "The project settings.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectSettings" - }, - "projectName": { - "description": "The new project name.", - "type": "string" - }, - "multilingual": { - "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" - }, - "description": { - "description": "The project description.", - "type": "string" - }, - "language": { - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "CreateProjectOptions" - }, - "TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult": { - "description": "Represents the document evaluation result for a custom entity recognition project.", - "required": [ - "customEntityRecognitionResult" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - ], - "properties": { - "customEntityRecognitionResult": { - "description": "Represents the evaluation prediction for entity recognition.", - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult" - } - }, - "x-ms-discriminator-value": "CustomEntityRecognition", - "x-ms-client-name": "CustomEntityRecognitionDocumentEvaluationResult" - }, - "TextAnalysisAuthoringCustomEntityRecognitionEvaluationSummary": { - "description": "Represents the evaluation summary for a custom entity recognition project.", - "required": [ - "customEntityRecognitionEvaluation" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - ], - "properties": { - "customEntityRecognitionEvaluation": { - "description": "Contains the data related to extraction evaluation.", - "$ref": "#/definitions/TextAnalysisAuthoringEntityRecognitionEvaluationSummary" - } - }, - "x-ms-discriminator-value": "CustomEntityRecognition", - "x-ms-client-name": "CustomEntityRecognitionEvaluationSummary" - }, - "TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult": { - "description": "Represents the document evaluation result for a custom multi-label classification project.", - "required": [ - "customMultiLabelClassificationResult" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - ], - "properties": { - "customMultiLabelClassificationResult": { - "description": "Represents the evaluation prediction for multi label classification.", - "$ref": "#/definitions/TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult" - } - }, - "x-ms-discriminator-value": "CustomMultiLabelClassification", - "x-ms-client-name": "CustomMultiLabelClassificationDocumentEvaluationResult" - }, - "TextAnalysisAuthoringCustomMultiLabelClassificationEvaluationSummary": { - "description": "Represents the evaluation summary for a custom multi-label classification project.", - "required": [ - "customMultiLabelClassificationEvaluation" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - ], - "properties": { - "customMultiLabelClassificationEvaluation": { - "description": "Contains the data related to multi label classification evaluation.", - "$ref": "#/definitions/TextAnalysisAuthoringMultiLabelClassificationEvaluationSummary" - } - }, - "x-ms-discriminator-value": "CustomMultiLabelClassification", - "x-ms-client-name": "CustomMultiLabelClassificationEvaluationSummary" - }, - "TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult": { - "description": "Represents the document evaluation result for a custom single-label classification project.", - "required": [ - "customSingleLabelClassificationResult" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - ], - "properties": { - "customSingleLabelClassificationResult": { - "description": "Represents the evaluation prediction for single label classification.", - "$ref": "#/definitions/TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult" - } - }, - "x-ms-discriminator-value": "CustomSingleLabelClassification", - "x-ms-client-name": "CustomSingleLabelClassificationDocumentEvaluationResult" - }, - "TextAnalysisAuthoringCustomSingleLabelClassificationEvaluationSummary": { - "description": "Represents the evaluation summary for a custom single-label classification project.", - "required": [ - "customSingleLabelClassificationEvaluation" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - ], - "properties": { - "customSingleLabelClassificationEvaluation": { - "description": "Contains the data related to single label classification evaluation.", - "$ref": "#/definitions/TextAnalysisAuthoringSingleLabelClassificationEvaluationSummary" - } - }, - "x-ms-discriminator-value": "CustomSingleLabelClassification", - "x-ms-client-name": "CustomSingleLabelClassificationEvaluationSummary" - }, - "TextAnalysisAuthoringDeleteDeploymentOptions": { - "description": "Represents the options for deleting a project deployment.", - "type": "object", - "properties": { - "assignedResourceIds": { - "description": "Represents the resource IDs to delete the deployment from.\n If not provided, the deployment will be rolled out from all the resources it is deployed to.\n If provided, it will delete the deployment only from the specified assigned resources, and leave it for the rest.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ms-client-name": "DeleteDeploymentOptions" - }, - "TextAnalysisAuthoringDeploymentJobState": { - "description": "Represents the state of a deployment job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "DeploymentJobState" - }, - "TextAnalysisAuthoringDeploymentResource": { - "description": "Represents an Azure resource assigned to a deployment.", - "required": [ - "resourceId", - "region" - ], - "type": "object", - "properties": { - "resourceId": { - "description": "Represents the Azure resource Id.", - "type": "string" - }, - "region": { - "description": "Represents the resource region.", - "type": "string" - } - }, - "x-ms-client-name": "DeploymentResource" - }, - "TextAnalysisAuthoringDeploymentResourcesJobState": { - "description": "Represents the state of a deployment resources job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "DeploymentResourcesJobState" - }, - "TextAnalysisAuthoringDocumentEntityLabelEvaluationResult": { - "description": "Represents an evaluation result entity label.", - "required": [ - "category", - "offset", - "length" - ], - "type": "object", - "properties": { - "category": { - "description": "Represents the entity category.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "Represents the entity offset index relative to the original text.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "Represents the entity length.", - "type": "integer" - } - }, - "x-ms-client-name": "DocumentEntityLabelEvaluationResult" - }, - "TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult": { - "description": "Represents the entity recognition evaluation result for a document.", - "required": [ - "entities" - ], - "type": "object", - "properties": { - "entities": { - "description": "Represents the document labelled entities.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityRegionEvaluationResult" - } - } - }, - "x-ms-client-name": "DocumentEntityRecognitionEvaluationResult" - }, - "TextAnalysisAuthoringDocumentEntityRegionEvaluationResult": { - "description": "Represents the evaluation comparison between the expected and predicted entities of a document region.", - "required": [ - "expectedEntities", - "predictedEntities", - "regionOffset", - "regionLength" - ], - "type": "object", - "properties": { - "expectedEntities": { - "description": "Represents the region's expected entity labels.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityLabelEvaluationResult" - } - }, - "predictedEntities": { - "description": "Represents the region's predicted entity labels.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityLabelEvaluationResult" - } - }, - "regionOffset": { - "format": "int32", - "description": "Represents the region offset.", - "type": "integer" - }, - "regionLength": { - "format": "int32", - "description": "Represents the region length.", - "type": "integer" - } - }, - "x-ms-client-name": "DocumentEntityRegionEvaluationResult" - }, - "TextAnalysisAuthoringDocumentEvaluationResult": { - "description": "Represents the evaluation result of a document.", - "required": [ - "location", - "language", - "projectKind" - ], - "type": "object", - "properties": { - "location": { - "description": "Represents the document path.", - "type": "string" - }, - "language": { - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "projectKind": { - "description": "Represents the project kind.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" - } - }, - "discriminator": "projectKind", - "x-ms-client-name": "DocumentEvaluationResult" - }, - "TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult": { - "description": "Represents the comparison between the expected and predicted classes that are result from the evaluation operation.", - "required": [ - "expectedClasses", - "predictedClasses" - ], - "type": "object", - "properties": { - "expectedClasses": { - "description": "Represents the document's expected classes.", - "type": "array", - "items": { - "type": "string" - } - }, - "predictedClasses": { - "description": "Represents the document's predicted classes.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ms-client-name": "DocumentMultiLabelClassificationEvaluationResult" - }, - "TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult": { - "description": "Represents the comparison between the expected and predicted class that result from an evaluation operation.", - "required": [ - "expectedClass", - "predictedClass" - ], - "type": "object", - "properties": { - "expectedClass": { - "description": "Represents the document's expected class.", - "type": "string" - }, - "predictedClass": { - "description": "Represents the document's predicted class.", - "type": "string" - } - }, - "x-ms-client-name": "DocumentSingleLabelClassificationEvaluationResult" - }, - "TextAnalysisAuthoringEntityEvaluationSummary": { - "description": "Represents the evaluation summary for an entity.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], - "type": "object", - "properties": { - "f1": { - "format": "double", - "description": "Represents the model precision", - "type": "number" - }, - "precision": { - "format": "double", - "description": "Represents the model recall", - "type": "number" - }, - "recall": { - "format": "double", - "description": "Represents the model F1 score", - "type": "number" - }, - "truePositiveCount": { - "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" - }, - "trueNegativeCount": { - "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" - }, - "falsePositiveCount": { - "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" - }, - "falseNegativeCount": { - "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" - } - }, - "x-ms-client-name": "EntityEvaluationSummary" - }, - "TextAnalysisAuthoringEntityRecognitionEvaluationSummary": { - "description": "Represents the evaluation summary for a custom entity recognition project.", - "required": [ - "confusionMatrix", - "entities", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], - "type": "object", - "properties": { - "confusionMatrix": { - "description": "Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted.", - "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrix" - }, - "entities": { - "description": "Represents the entities evaluation", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringEntityEvaluationSummary" - } - }, - "microF1": { - "format": "float", - "description": "Represents the micro F1", - "type": "number" - }, - "microPrecision": { - "format": "float", - "description": "Represents the micro precision", - "type": "number" - }, - "microRecall": { - "format": "float", - "description": "Represents the micro recall", - "type": "number" - }, - "macroF1": { - "format": "float", - "description": "Represents the macro F1", - "type": "number" - }, - "macroPrecision": { - "format": "float", - "description": "Represents the macro precision", - "type": "number" - }, - "macroRecall": { - "format": "float", - "description": "Represents the macro recall", - "type": "number" - } - }, - "x-ms-client-name": "EntityRecognitionEvaluationSummary" - }, - "TextAnalysisAuthoringEvaluationKind": { - "enum": [ - "percentage", - "manual" - ], - "type": "string", - "x-ms-enum": { - "name": "EvaluationKind", - "modelAsString": true, - "values": [ - { - "value": "percentage", - "description": "Split the data into training and test sets according to user-defined percentages." - }, - { - "value": "manual", - "description": "Split the data according to the chosen dataset for every example in the data." - } - ] - }, - "x-ms-client-name": "EvaluationKind" - }, - "TextAnalysisAuthoringEvaluationOptions": { - "description": "Represents the options used running the evaluation.", - "type": "object", - "properties": { - "kind": { - "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationKind" - }, - "trainingSplitPercentage": { - "format": "int32", - "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" - }, - "testingSplitPercentage": { - "format": "int32", - "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" - } - }, - "x-ms-client-name": "EvaluationOptions" - }, - "TextAnalysisAuthoringEvaluationResults": { - "description": "Represents a list of results for an evaluation operation.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "THe list of documents evaluation results.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "EvaluationResults" - }, - "TextAnalysisAuthoringEvaluationSummary": { - "description": "Represents the summary for an evaluation operation.", - "required": [ - "projectKind", - "evaluationOptions" - ], - "type": "object", - "properties": { - "projectKind": { - "description": "Represents the project type that the evaluation ran on.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" - }, - "evaluationOptions": { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions" - } - }, - "discriminator": "projectKind", - "x-ms-client-name": "EvaluationSummary" - }, - "TextAnalysisAuthoringExportedClass": { - "description": "Represents a class of an exported project.", - "type": "object", - "properties": { - "category": { - "description": "The class category.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedClass" - }, - "TextAnalysisAuthoringExportedCustomAbstractiveSummarizationDocument": { - "description": "Represents an exported document for a custom abstractive summarization project.", - "required": [ - "summaryLocation" - ], - "type": "object", - "properties": { - "summaryLocation": { - "description": "Represents the summary file location in the blob store container associated with the project.", - "type": "string" - }, - "location": { - "description": "The location of the document in the storage.", - "type": "string" - }, - "language": { - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedCustomAbstractiveSummarizationDocument" - }, - "TextAnalysisAuthoringExportedCustomAbstractiveSummarizationProjectAssets": { - "description": "Represents the exported assets for an abstractive summarization project.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - ], - "properties": { - "documents": { - "description": "The list of documents belonging to this project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomAbstractiveSummarizationDocument" - } - } - }, - "x-ms-discriminator-value": "CustomAbstractiveSummarization", - "x-ms-client-name": "ExportedCustomAbstractiveSummarizationProjectAssets" - }, - "TextAnalysisAuthoringExportedCustomEntityRecognitionDocument": { - "description": "Represents an exported document for a custom entity recognition project.", - "type": "object", - "properties": { - "entities": { - "description": "The list of entity labels belonging to the document.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentRegion" - } - }, - "location": { - "description": "The location of the document in the storage.", - "type": "string" - }, - "language": { - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedCustomEntityRecognitionDocument" - }, - "TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets": { - "description": "Represents the exported assets for a entity recognition project.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - ], - "properties": { - "entities": { - "description": "The list of entities belonging to the project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedEntity" - } - }, - "documents": { - "description": "The list of documents belonging to the project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomEntityRecognitionDocument" - } - } - }, - "x-ms-discriminator-value": "CustomEntityRecognition", - "x-ms-client-name": "ExportedCustomEntityRecognitionProjectAssets" - }, - "TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument": { - "description": "Represents an exported document of a custom multi-label classification project.", - "type": "object", - "properties": { - "classes": { - "description": "The document classes.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentClass" - } - }, - "location": { - "description": "The location of the document in the storage.", - "type": "string" - }, - "language": { - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedCustomMultiLabelClassificationDocument" - }, - "TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets": { - "description": "Represents the exported assets for a custom multi-label classification project.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - ], - "properties": { - "classes": { - "description": "The list of classes in the project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedClass" - } - }, - "documents": { - "description": "The list of documents in the project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument" - } - } - }, - "x-ms-discriminator-value": "CustomMultiLabelClassification", - "x-ms-client-name": "ExportedCustomMultiLabelClassificationProjectAssets" - }, - "TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument": { - "description": "Represents an exported document for a custom single-label classification project.", - "type": "object", - "properties": { - "class": { - "description": "The class of the documents.", - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentClass" - }, - "location": { - "description": "The location of the document in the storage.", - "type": "string" - }, - "language": { - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedCustomSingleLabelClassificationDocument" - }, - "TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets": { - "description": "Represents the exported assets for a single-label classification project.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - ], - "properties": { - "classes": { - "description": "The list of classes belonging to this project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedClass" - } - }, - "documents": { - "description": "The list of documents belonging to this project.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument" - } - } - }, - "x-ms-discriminator-value": "CustomSingleLabelClassification", - "x-ms-client-name": "ExportedCustomSingleLabelClassificationProjectAssets" - }, - "TextAnalysisAuthoringExportedDocumentClass": { - "description": "Represents a classification label for a document.", - "type": "object", - "properties": { - "category": { - "type": "string" - } - }, - "x-ms-client-name": "ExportedDocumentClass" - }, - "TextAnalysisAuthoringExportedDocumentEntityLabel": { - "description": "Represents an entity label for a document.", - "type": "object", - "properties": { - "category": { - "description": "The entity category.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "Start position for the entity text.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "Length for the entity text.", - "type": "integer" - } - }, - "x-ms-client-name": "ExportedDocumentEntityLabel" - }, - "TextAnalysisAuthoringExportedDocumentRegion": { - "description": "Represents a region in a document for entity labeling.", - "type": "object", - "properties": { - "regionOffset": { - "format": "int32", - "description": "Start position for the region.", - "type": "integer" - }, - "regionLength": { - "format": "int32", - "description": "Length for the region text.", - "type": "integer" - }, - "labels": { - "description": "The list of entity labels belonging to this region.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentEntityLabel" - } - } - }, - "x-ms-client-name": "ExportedDocumentRegion" - }, - "TextAnalysisAuthoringExportedEntity": { - "description": "Represents an entity in an exported project.", - "type": "object", - "properties": { - "category": { - "description": "The entity category.", - "type": "string" - } - }, - "x-ms-client-name": "ExportedEntity" - }, - "TextAnalysisAuthoringExportedProject": { - "description": "Represents an exported project.", - "required": [ - "projectFileVersion", - "stringIndexType", - "metadata" - ], - "type": "object", - "properties": { - "projectFileVersion": { - "description": "The version of the exported file.", - "type": "string" - }, - "stringIndexType": { - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "$ref": "#/definitions/TextAnalysisAuthoringStringIndexType" - }, - "metadata": { - "description": "Represents the project metadata.", - "$ref": "#/definitions/TextAnalysisAuthoringCreateProjectOptions" - }, - "assets": { - "description": "Represents the project assets.", - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - }, - "x-ms-client-name": "ExportedProject" - }, - "TextAnalysisAuthoringExportedProjectAssets": { - "description": "Represents the assets of an exported project.", - "required": [ - "projectKind" - ], - "type": "object", - "properties": { - "projectKind": { - "description": "The type of the project the assets belong to.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" - } - }, - "discriminator": "projectKind", - "x-ms-client-name": "ExportedProjectAssets" - }, - "TextAnalysisAuthoringExportProjectJobState": { - "description": "Represents the state of an export job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringJobState" - } - ], - "properties": { - "resultUrl": { - "description": "The URL to use in order to download the exported project.", - "type": "string" - } - }, - "x-ms-client-name": "ExportProjectJobState" - }, - "TextAnalysisAuthoringImportProjectJobState": { - "description": "Represents the state of an import job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "ImportProjectJobState" - }, - "TextAnalysisAuthoringJobState": { - "description": "Represents a job's state.", - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ], - "type": "object", - "properties": { - "jobId": { - "description": "The job ID.", - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "description": "The creation date time of the job.", - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "description": "The last date time the job was updated.", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "description": "The expiration date time of the job.", - "type": "string" - }, - "status": { - "description": "The job status.", - "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" - }, - "warnings": { - "description": "The warnings that were encountered while executing the job.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringWarning" - } - }, - "errors": { - "description": "The errors encountered while executing the job.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - } - }, - "x-ms-client-name": "JobState" - }, - "TextAnalysisAuthoringJobStatus": { - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling", - "partiallyCompleted" - ], - "type": "string", - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true - }, - "x-ms-client-name": "JobStatus" - }, - "TextAnalysisAuthoringLoadSnapshotJobState": { - "description": "Represents the state of loading a snapshot job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "LoadSnapshotJobState" - }, - "TextAnalysisAuthoringMultiLabelClassEvaluationSummary": { - "description": "Represents the evaluation summary of a class in a multi-label classification project.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], - "type": "object", - "properties": { - "f1": { - "format": "double", - "description": "Represents the model precision", - "type": "number" - }, - "precision": { - "format": "double", - "description": "Represents the model recall", - "type": "number" - }, - "recall": { - "format": "double", - "description": "Represents the model F1 score", - "type": "number" - }, - "truePositiveCount": { - "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" - }, - "trueNegativeCount": { - "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" - }, - "falsePositiveCount": { - "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" - }, - "falseNegativeCount": { - "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" - } - }, - "x-ms-client-name": "MultiLabelClassEvaluationSummary" - }, - "TextAnalysisAuthoringMultiLabelClassificationEvaluationSummary": { - "description": "Represents the evaluation summary for a multi-label classification project.", - "required": [ - "classes", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], - "type": "object", - "properties": { - "classes": { - "description": "Represents the classes evaluation", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringMultiLabelClassEvaluationSummary" - } - }, - "microF1": { - "format": "float", - "description": "Represents the micro F1", - "type": "number" - }, - "microPrecision": { - "format": "float", - "description": "Represents the micro precision", - "type": "number" - }, - "microRecall": { - "format": "float", - "description": "Represents the micro recall", - "type": "number" - }, - "macroF1": { - "format": "float", - "description": "Represents the macro F1", - "type": "number" - }, - "macroPrecision": { - "format": "float", - "description": "Represents the macro precision", - "type": "number" - }, - "macroRecall": { - "format": "float", - "description": "Represents the macro recall", - "type": "number" - } - }, - "x-ms-client-name": "MultiLabelClassificationEvaluationSummary" - }, - "TextAnalysisAuthoringProjectDeletionJobState": { - "description": "Represents the state of a project deletion job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "ProjectDeletionJobState" - }, - "TextAnalysisAuthoringProjectDeployment": { - "description": "Represents a project deployment.", - "required": [ - "deploymentName", - "modelId", - "lastTrainedDateTime", - "lastDeployedDateTime", - "deploymentExpirationDate", - "modelTrainingConfigVersion" - ], - "type": "object", - "properties": { - "deploymentName": { - "description": "Represents deployment name.", - "type": "string" - }, - "modelId": { - "description": "Represents deployment modelId.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "Represents deployment last trained time.", - "type": "string" - }, - "lastDeployedDateTime": { - "format": "date-time", - "description": "Represents deployment last deployed time.", - "type": "string" - }, - "deploymentExpirationDate": { - "format": "date", - "description": "Represents deployment expiration date in the runtime.", - "type": "string" - }, - "modelTrainingConfigVersion": { - "description": "Represents model training config version.", - "type": "string" - }, - "assignedResources": { - "description": "Represents the metadata of the assigned Azure resources.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDeploymentResource" - } - } - }, - "x-ms-client-name": "ProjectDeployment" - }, - "TextAnalysisAuthoringProjectDeployments": { - "description": "Represents a list of retrieved deployments.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved deployments.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployment" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectDeployments" - }, - "TextAnalysisAuthoringProjectKind": { - "enum": [ - "CustomSingleLabelClassification", - "CustomMultiLabelClassification", - "CustomEntityRecognition", - "CustomAbstractiveSummarization" - ], - "type": "string", - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "value": "CustomSingleLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B." - }, - { - "value": "CustomMultiLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C." - }, - { - "value": "CustomEntityRecognition", - "description": "For building an extraction model to identify your domain categories using your own data." - }, - { - "value": "CustomAbstractiveSummarization", - "description": "For building an abstractive summarization models which are able to summarize long documents." - } - ] - }, - "x-ms-client-name": "ProjectKind" - }, - "TextAnalysisAuthoringProjectMetadata": { - "description": "Represents the metadata of a project.", - "required": [ - "createdDateTime", - "lastModifiedDateTime", - "projectKind", - "storageInputContainerName", - "projectName", - "language" - ], - "type": "object", - "properties": { - "createdDateTime": { - "format": "date-time", - "description": "Represents the project creation datetime.", - "type": "string" - }, - "lastModifiedDateTime": { - "format": "date-time", - "description": "Represents the project last modification datetime.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "Represents the project last training datetime.", - "type": "string" - }, - "lastDeployedDateTime": { - "format": "date-time", - "description": "Represents the project last deployment datetime.", - "type": "string" - }, - "projectKind": { - "description": "The project kind.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" - }, - "storageInputContainerName": { - "description": "The storage container name.", - "type": "string" - }, - "settings": { - "description": "The project settings.", - "$ref": "#/definitions/TextAnalysisAuthoringProjectSettings" - }, - "projectName": { - "description": "The new project name.", - "type": "string" - }, - "multilingual": { - "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" - }, - "description": { - "description": "The project description.", - "type": "string" - }, - "language": { - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "ProjectMetadata" - }, - "TextAnalysisAuthoringProjectSettings": { - "description": "Represents the settings used to define the project behavior.", - "type": "object", - "properties": { - "confidenceThreshold": { - "format": "float", - "description": "The threshold of the class with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive.", - "type": "number" - } - }, - "x-ms-client-name": "ProjectSettings" - }, - "TextAnalysisAuthoringProjectsMetadata": { - "description": "Represents a list of retrieved projects' metadata.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of projects.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectsMetadata" - }, - "TextAnalysisAuthoringProjectTrainedModel": { - "description": "Represents a trained model.", - "required": [ - "label", - "modelId", - "lastTrainedDateTime", - "lastTrainingDurationInSeconds", - "modelExpirationDate", - "modelTrainingConfigVersion" - ], - "type": "object", - "properties": { - "label": { - "description": "The trained model label.", - "type": "string" - }, - "modelId": { - "description": "The model ID.", - "type": "string" - }, - "lastTrainedDateTime": { - "format": "date-time", - "description": "The last trained date time of the model.", - "type": "string" - }, - "lastTrainingDurationInSeconds": { - "format": "int32", - "description": "The duration of the model's last training request in seconds.", - "type": "integer" - }, - "modelExpirationDate": { - "format": "date", - "description": "The model expiration date.", - "type": "string" - }, - "modelTrainingConfigVersion": { - "description": "The model training config version.", - "type": "string" - }, - "hasSnapshot": { - "description": "The flag to indicate if the trained model has a snapshot ready.", - "type": "boolean" - } - }, - "x-ms-client-name": "ProjectTrainedModel" - }, - "TextAnalysisAuthoringProjectTrainedModels": { - "description": "Represents a list of retrieved trained models.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved jobs.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModel" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectTrainedModels" - }, - "TextAnalysisAuthoringResourceMetadata": { - "description": "Represents metadata for the Azure resource..", - "required": [ - "azureResourceId", - "customDomain", - "region" - ], - "type": "object", - "properties": { - "azureResourceId": { - "description": "Represents the Azure resource ID.", - "type": "string" - }, - "customDomain": { - "description": "Represents the Azure resource custom domain.", - "type": "string" - }, - "region": { - "description": "Represents the Azure resource region.", - "type": "string" - } - }, - "x-ms-client-name": "ResourceMetadata" - }, - "TextAnalysisAuthoringSingleLabelClassEvaluationSummary": { - "description": "Represents the evaluation summary for a class in a single-label classification project.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], - "type": "object", - "properties": { - "f1": { - "format": "double", - "description": "Represents the model precision", - "type": "number" - }, - "precision": { - "format": "double", - "description": "Represents the model recall", - "type": "number" - }, - "recall": { - "format": "double", - "description": "Represents the model F1 score", - "type": "number" - }, - "truePositiveCount": { - "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" - }, - "trueNegativeCount": { - "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" - }, - "falsePositiveCount": { - "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" - }, - "falseNegativeCount": { - "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" - } - }, - "x-ms-client-name": "SingleLabelClassEvaluationSummary" - }, - "TextAnalysisAuthoringSingleLabelClassificationEvaluationSummary": { - "description": "Represents the evaluation summary for a custom single-label classification project.", - "required": [ - "confusionMatrix", - "classes", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], - "type": "object", - "properties": { - "confusionMatrix": { - "description": "Represents the confusion matrix between two classes (the two classes can be the same). The matrix is between the class that was labelled and the class that was predicted.", - "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrix" - }, - "classes": { - "description": "Represents the classes evaluation", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringSingleLabelClassEvaluationSummary" - } - }, - "microF1": { - "format": "float", - "description": "Represents the micro F1", - "type": "number" - }, - "microPrecision": { - "format": "float", - "description": "Represents the micro precision", - "type": "number" - }, - "microRecall": { - "format": "float", - "description": "Represents the micro recall", - "type": "number" - }, - "macroF1": { - "format": "float", - "description": "Represents the macro F1", - "type": "number" - }, - "macroPrecision": { - "format": "float", - "description": "Represents the macro precision", - "type": "number" - }, - "macroRecall": { - "format": "float", - "description": "Represents the macro recall", - "type": "number" - } - }, - "x-ms-client-name": "SingleLabelClassificationEvaluationSummary" - }, - "TextAnalysisAuthoringStringIndexType": { - "enum": [ - "Utf16CodeUnit" - ], - "type": "string", - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - }, - "x-ms-client-name": "StringIndexType" - }, - "TextAnalysisAuthoringSubTrainingJobState": { - "description": "Represents the detailed state of a training sub-operation.", - "required": [ - "percentComplete", - "status" - ], - "type": "object", - "properties": { - "percentComplete": { - "format": "int32", - "description": "Represents progress percentage.", - "type": "integer" - }, - "startDateTime": { - "format": "date-time", - "description": "Represents the start date time.", - "type": "string" - }, - "endDateTime": { - "format": "date-time", - "description": "Represents the end date time.", - "type": "string" - }, - "status": { - "description": "Represents the status of the sub-operation.", - "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" - } - }, - "x-ms-client-name": "SubTrainingJobState" - }, - "TextAnalysisAuthoringSupportedLanguage": { - "description": "Represents a supported language.", - "required": [ - "languageName", - "languageCode" - ], - "type": "object", - "properties": { - "languageName": { - "description": "The language name.", - "type": "string" - }, - "languageCode": { - "description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - } - }, - "x-ms-client-name": "SupportedLanguage" - }, - "TextAnalysisAuthoringSupportedLanguages": { - "description": "Represents a list of retrieved languages.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of the languages.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringSupportedLanguage" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "SupportedLanguages" - }, - "TextAnalysisAuthoringSwapDeploymentsOptions": { - "description": "Represents the options for swapping two deployments together.", - "required": [ - "firstDeploymentName", - "secondDeploymentName" - ], - "type": "object", - "properties": { - "firstDeploymentName": { - "description": "Represents the first deployment name.", - "type": "string" - }, - "secondDeploymentName": { - "description": "Represents the second deployment name.", - "type": "string" - } - }, - "x-ms-client-name": "SwapDeploymentsOptions" - }, - "TextAnalysisAuthoringTrainingConfigVersion": { - "description": "Represents a training config version.", - "required": [ - "trainingConfigVersion", - "modelExpirationDate" - ], - "type": "object", - "properties": { - "trainingConfigVersion": { - "description": "Represents the version of the config.", - "type": "string" - }, - "modelExpirationDate": { - "format": "date", - "description": "Represents the training config version expiration date.", - "type": "string" - } - }, - "x-ms-client-name": "TrainingConfigVersion" - }, - "TextAnalysisAuthoringTrainingConfigVersions": { - "description": "Represents a list of training config versions.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of the training config versions.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingConfigVersion" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "TrainingConfigVersions" - }, - "TextAnalysisAuthoringTrainingJobOptions": { - "description": "Represents the options for starting a new training job.", - "required": [ - "modelLabel", - "trainingConfigVersion" - ], - "type": "object", - "properties": { - "modelLabel": { - "description": "Represents the output model label.", - "type": "string" - }, - "trainingConfigVersion": { - "description": "Represents training config version.", - "type": "string" - }, - "evaluationOptions": { - "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20.", - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions" - } - }, - "x-ms-client-name": "TrainingJobOptions" - }, - "TextAnalysisAuthoringTrainingJobResult": { - "description": "Represents the output of a training job.", - "required": [ - "modelLabel", - "trainingConfigVersion", - "trainingStatus" - ], - "type": "object", - "properties": { - "modelLabel": { - "description": "Represents trained model label.", - "type": "string" - }, - "trainingConfigVersion": { - "description": "Represents training config version.", - "type": "string" - }, - "trainingStatus": { - "description": "Represents model train status.", - "$ref": "#/definitions/TextAnalysisAuthoringSubTrainingJobState" - }, - "evaluationStatus": { - "description": "Represents model evaluation status.", - "$ref": "#/definitions/TextAnalysisAuthoringSubTrainingJobState" - }, - "estimatedEndDateTime": { - "format": "date-time", - "description": "Represents the estimate end date time for training and evaluation.", - "type": "string" - } - }, - "x-ms-client-name": "TrainingJobResult" - }, - "TextAnalysisAuthoringTrainingJobs": { - "description": "Represents a list of retrieved training jobs.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of jobs.", - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobState" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "TrainingJobs" - }, - "TextAnalysisAuthoringTrainingJobState": { - "description": "Represents the state of a training job.", - "required": [ - "result" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringJobState" - } - ], - "properties": { - "result": { - "description": "Represents training tasks detailed result.", - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobResult" - } - }, - "x-ms-client-name": "TrainingJobState" - }, - "TextAnalysisAuthoringUnassignDeploymentResourcesOptions": { - "description": "Represents the options to unassign Azure resources from a project.", - "required": [ - "assignedResourceIds" - ], - "type": "object", - "properties": { - "assignedResourceIds": { - "description": "Represents the assigned resource IDs to be unassigned.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ms-client-name": "UnassignDeploymentResourcesOptions" - }, - "TextAnalysisAuthoringWarning": { - "description": "Represents a warning that was encountered while executing the request.", - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "description": "The warning code.", - "type": "string" - }, - "message": { - "description": "The warning message.", - "type": "string" - } - }, - "x-ms-client-name": "Warning" - } - }, - "parameters": { - "TextAnalysisAuthoringStringIndexTypeQueryParameter": { - "in": "query", - "name": "stringIndexType", - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "required": true, - "type": "string", - "enum": [ - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "TextAnalysisAuthoringJobIdPathParameter": { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "TextAnalysisAuthoringTrainedModelLabelPathParameter": { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model label.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "TextAnalysisAuthoringProjectKindQueryOptionalParameter": { - "in": "query", - "name": "projectKind", - "description": "The project kind, default value is CustomSingleLabelClassification.", - "type": "string", - "enum": [ - "CustomSingleLabelClassification", - "CustomMultiLabelClassification", - "CustomEntityRecognition", - "CustomAbstractiveSummarization" - ], - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "value": "CustomSingleLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B." - }, - { - "value": "CustomMultiLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C." - }, - { - "value": "CustomEntityRecognition", - "description": "For building an extraction model to identify your domain categories using your own data." - }, - { - "value": "CustomAbstractiveSummarization", - "description": "For building an abstractive summarization models which are able to summarize long documents." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "TextAnalysisAuthoringProjectKindQueryParameter": { - "in": "query", - "name": "projectKind", - "description": "The project kind.", - "required": true, - "type": "string", - "enum": [ - "CustomSingleLabelClassification", - "CustomMultiLabelClassification", - "CustomEntityRecognition", - "CustomAbstractiveSummarization" - ], - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "value": "CustomSingleLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B." - }, - { - "value": "CustomMultiLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C." - }, - { - "value": "CustomEntityRecognition", - "description": "For building an extraction model to identify your domain categories using your own data." - }, - { - "value": "CustomAbstractiveSummarization", - "description": "For building an abstractive summarization models which are able to summarize long documents." - } - ] - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/analyzetext.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/analyzetext.json deleted file mode 100644 index 534d1b764d07..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/analyzetext.json +++ /dev/null @@ -1,3635 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Text Analysis", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/azure/cognitive-services/language-service/overview.0", - "version": "2022-10-01-preview" - }, - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" - } - }, - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://cognitiveservices.azure.com/.default" - ] - }, - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/:analyze-text": { - "post": { - "summary": "Request text analysis over a collection of documents.", - "description": "Submit a collection of text documents for analysis. Specify a single unique task to be executed immediately.", - "operationId": "AnalyzeText", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/ShowStats" - }, - { - "description": "Collection of documents to analyze and a single task to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeTextTask" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "A successful call result", - "schema": { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Entity Linking Request": { - "$ref": "./examples/text/SuccessfulEntityLinkingRequest.json" - }, - "Successful Entity Recognition Request": { - "$ref": "./examples/text/SuccessfulEntityRecognitionRequest.json" - }, - "Successful Key Phrase Extraction Request": { - "$ref": "./examples/text/SuccessfulKeyPhraseExtractionRequest.json" - }, - "Successful PII Entity Recognition Request": { - "$ref": "./examples/text/SuccessfulPiiEntityRecognitionRequest.json" - }, - "Successful Language Detection Request": { - "$ref": "./examples/text/SuccessfulLanguageDetectionRequest.json" - }, - "Successful Sentiment Analysis Request": { - "$ref": "./examples/text/SuccessfulSentimentAnalysisRequest.json" - } - } - } - }, - "/analyze-text/jobs": { - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "description": "Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.", - "operationId": "AnalyzeText_SubmitJob", - "summary": "Submit text analysis job", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Collection of documents to analyze and one or more tasks to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeTextJobsInput" - }, - "required": true - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Submit Analysis Job Request": { - "$ref": "./examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json" - }, - "Successful Healthcare Post Request": { - "$ref": "./examples/text/SuccessfulHealthcarePostRequest.json" - }, - "Successful Submit Abstractive Summarization Task": { - "$ref": "./examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.json" - }, - "Successful Healthcare DocumentType Post Request": { - "$ref": "./examples/text/SuccessfulHealthcareDocumentTypePostRequest.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/analyze-text/jobs/{jobId}": { - "get": { - "produces": [ - "application/json" - ], - "description": "Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are succeeded, the job will transition to the succeeded state and results will be available for each task.", - "operationId": "AnalyzeText_JobStatus", - "summary": "Get analysis status and results", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/JobId" - }, - { - "$ref": "common.json#/parameters/ShowStats" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - } - ], - "responses": { - "200": { - "description": "Analysis job status and metadata.", - "schema": { - "$ref": "#/definitions/AnalyzeTextJobState" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Text Analysis Job Status Request": { - "$ref": "./examples/text/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json" - }, - "Successful Get Text Analysis Health Request": { - "$ref": "./examples/text/SuccessfulHealthcareTaskStatusRequest.json" - }, - "Successful Get Abstractive Summarization Result": { - "$ref": "./examples/text/SuccessfulAbstractiveSummarizationTaskResult.json" - }, - "Successful Get Text Analysis Health DocumentType Request": { - "$ref": "./examples/text/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json" - } - } - } - }, - "/analyze-text/jobs/{jobId}:cancel": { - "post": { - "produces": [ - "application/json" - ], - "description": "Cancel a long-running Text Analysis job.", - "operationId": "AnalyzeText_CancelJob", - "summary": "Cancel a long-running Text Analysis job", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/JobId" - } - ], - "responses": { - "202": { - "description": "Cancel Job request has been received.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Job Delete Request": { - "$ref": "./examples/text/SuccessfulAnalyzeTextJobsCancelRequest.json" - } - }, - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "AnalyzeTextTaskKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis tasks.", - "enum": [ - "SentimentAnalysis", - "EntityRecognition", - "PiiEntityRecognition", - "KeyPhraseExtraction", - "LanguageDetection", - "EntityLinking" - ], - "x-ms-enum": { - "name": "AnalyzeTextTaskKind", - "modelAsString": true - } - }, - "AnalyzeTextLROTaskKind": { - "type": "string", - "description": "Enumeration of supported long-running Text Analysis tasks.", - "enum": [ - "SentimentAnalysis", - "EntityRecognition", - "PiiEntityRecognition", - "KeyPhraseExtraction", - "EntityLinking", - "Healthcare", - "ExtractiveSummarization", - "CustomEntityRecognition", - "CustomSingleLabelClassification", - "CustomMultiLabelClassification", - "AbstractiveSummarization" - ], - "x-ms-enum": { - "name": "AnalyzeTextLROTaskKind", - "modelAsString": true - } - }, - "AnalyzeTextTaskResultsKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis task results.", - "enum": [ - "SentimentAnalysisResults", - "EntityRecognitionResults", - "PiiEntityRecognitionResults", - "KeyPhraseExtractionResults", - "LanguageDetectionResults", - "EntityLinkingResults" - ], - "x-ms-enum": { - "name": "AnalyzeTextTaskResultsKind", - "modelAsString": true - } - }, - "AnalyzeTextLROResultsKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis long-running operation task results.", - "enum": [ - "SentimentAnalysisLROResults", - "EntityRecognitionLROResults", - "PiiEntityRecognitionLROResults", - "KeyPhraseExtractionLROResults", - "EntityLinkingLROResults", - "HealthcareLROResults", - "ExtractiveSummarizationLROResults", - "CustomEntityRecognitionLROResults", - "CustomSingleLabelClassificationLROResults", - "CustomMultiLabelClassificationLROResults", - "AbstractiveSummarizationLROResults" - ], - "x-ms-enum": { - "name": "AnalyzeTextLROResultsKind", - "modelAsString": true - } - }, - "MultiLanguageAnalysisInput": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/definitions/MultiLanguageInput" - } - } - } - }, - "LanguageDetectionAnalysisInput": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/definitions/LanguageInput" - } - } - } - }, - "AnalyzeTextTask": { - "type": "object", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextTaskKind" - } - } - }, - "AnalyzeTextLROTask": { - "type": "object", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextLROTaskKind" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskIdentifier" - } - ] - }, - "AnalyzeTextTaskResult": { - "type": "object", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextTaskResultsKind" - } - } - }, - "AnalyzeTextEntityLinkingInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/EntityLinkingTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "EntityLinking" - }, - "AnalyzeTextEntityRecognitionInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/EntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "EntityRecognition" - }, - "AnalyzeTextKeyPhraseExtractionInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/KeyPhraseTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "KeyPhraseExtraction" - }, - "AnalyzeTextPiiEntitiesRecognitionInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/PiiTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "PiiEntityRecognition" - }, - "AnalyzeTextLanguageDetectionInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/LanguageDetectionAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/LanguageDetectionTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "LanguageDetection" - }, - "AnalyzeTextSentimentAnalysisInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/SentimentAnalysisTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "SentimentAnalysis" - }, - "AnalyzeTextJobsInput": { - "type": "object", - "properties": { - "displayName": { - "description": "Optional display name for the analysis job.", - "type": "string" - }, - "defaultLanguage": { - "description": "Default language to use for records requesting automatic language detection.", - "type": "string" - }, - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "tasks": { - "description": "The set of tasks to execute on the input documents.", - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - } - }, - "required": [ - "analysisInput", - "tasks" - ] - }, - "CustomTaskParameters": { - "type": "object", - "description": "Parameters object for a text analysis task using custom models.", - "properties": { - "projectName": { - "type": "string", - "description": "This field indicates the project name for the model." - }, - "deploymentName": { - "type": "string", - "description": "This field indicates the deployment name for the model." - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskParameters" - } - ], - "required": [ - "projectName", - "deploymentName" - ] - }, - "CustomResult": { - "type": "object", - "properties": { - "errors": { - "type": "array", - "description": "Errors by document id.", - "items": { - "$ref": "#/definitions/DocumentError" - } - }, - "statistics": { - "$ref": "common.json#/definitions/RequestStatistics" - }, - "projectName": { - "type": "string", - "description": "This field indicates the project name for the model." - }, - "deploymentName": { - "type": "string", - "description": "This field indicates the deployment name for the model." - } - }, - "required": [ - "errors", - "projectName", - "deploymentName" - ] - }, - "CustomEntitiesTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Entities task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/CustomTaskParameters" - } - ] - }, - "CustomEntitiesLROTask": { - "type": "object", - "description": "Use custom models to ease the process of information extraction from unstructured documents like contracts or financial documents", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomEntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomEntityRecognition" - }, - "CustomEntitiesResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/EntitiesDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/CustomResult" - } - ], - "required": [ - "documents" - ] - }, - "CustomSingleLabelClassificationTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Single Classification task.", - "allOf": [ - { - "$ref": "#/definitions/CustomTaskParameters" - } - ] - }, - "CustomSingleLabelClassificationLROTask": { - "type": "object", - "description": "Use custom models to classify text into single label taxonomy", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomSingleLabelClassificationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomSingleLabelClassification" - }, - "CustomLabelClassificationResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/ClassificationDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/CustomResult" - } - ], - "required": [ - "documents" - ] - }, - "ClassificationResult": { - "type": "object", - "required": [ - "category", - "confidenceScore" - ], - "properties": { - "category": { - "type": "string", - "description": "Classification type." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the recognized class." - } - } - }, - "CustomMultiLabelClassificationTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Multi Classification task.", - "allOf": [ - { - "$ref": "#/definitions/CustomTaskParameters" - } - ] - }, - "CustomMultiLabelClassificationLROTask": { - "type": "object", - "description": "Use custom models to classify text into multi label taxonomy", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomMultiLabelClassificationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomMultiLabelClassification" - }, - "ClassificationDocumentResult": { - "type": "object", - "properties": { - "class": { - "type": "array", - "items": { - "$ref": "#/definitions/ClassificationResult" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "class" - ] - }, - "HealthcareTaskParameters": { - "type": "object", - "description": "Supported parameters for a Healthcare task.", - "properties": { - "fhirVersion": { - "type": "string", - "description": "The FHIR Spec version that the result will use to format the fhirBundle. For additional information see https://www.hl7.org/fhir/overview.html.", - "enum": [ - "4.0.1" - ], - "x-ms-enum": { - "name": "fhirVersion", - "modelAsString": true - } - }, - "documentType": { - "x-ms-enum": { - "name": "healthcareDocumentType", - "modelAsString": true - }, - "type": "string", - "description": "Document type that can be provided as input for Fhir Documents. Expect to have fhirVersion provided when used. Behavior of using None enum is the same as not using the documentType parameter.", - "enum": [ - "None", - "ClinicalTrial", - "DischargeSummary", - "ProgressNote", - "HistoryAndPhysical", - "Consult", - "Imaging", - "Pathology", - "ProcedureNote" - ] - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "HealthcareLROTask": { - "type": "object", - "properties": { - "parameters": { - "$ref": "#/definitions/HealthcareTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "Healthcare" - }, - "HealthcareResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthcareEntitiesDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguageString" - } - ] - }, - "HealthcareEntitiesDocumentResult": { - "type": "object", - "properties": { - "entities": { - "description": "Healthcare entities.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareEntity" - } - }, - "relations": { - "type": "array", - "description": "Healthcare entity relations.", - "items": { - "$ref": "#/definitions/HealthcareRelation" - } - }, - "fhirBundle": { - "type": "object", - "description": "JSON bundle containing a FHIR compatible object for consumption in other Healthcare tools. For additional information see https://www.hl7.org/fhir/overview.html.", - "additionalProperties": {} - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "entities", - "relations" - ] - }, - "HealthcareEntity": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "x-ms-enum": { - "name": "healthcareEntityCategory", - "modelAsString": true - }, - "type": "string", - "description": "Healthcare Entity Category.", - "enum": [ - "BodyStructure", - "Age", - "Gender", - "ExaminationName", - "Date", - "Direction", - "Frequency", - "MeasurementValue", - "MeasurementUnit", - "RelationalOperator", - "Time", - "GeneOrProtein", - "Variant", - "AdministrativeEvent", - "CareEnvironment", - "HealthcareProfession", - "Diagnosis", - "SymptomOrSign", - "ConditionQualifier", - "MedicationClass", - "MedicationName", - "Dosage", - "MedicationForm", - "MedicationRoute", - "FamilyRelation", - "TreatmentName" - ] - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub type." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted entity." - }, - "assertion": { - "type": "object", - "$ref": "#/definitions/HealthcareAssertion" - }, - "name": { - "description": "Preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'.", - "type": "string" - }, - "links": { - "description": "Entity references in known data sources.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareEntityLink" - } - } - }, - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ] - }, - "HealthcareRelation": { - "type": "object", - "description": "Every relation is an entity graph of a certain relationType, where all entities are connected and have specific roles within the relation context.", - "required": [ - "relationType", - "entities" - ], - "properties": { - "relationType": { - "description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc.", - "type": "string", - "enum": [ - "Abbreviation", - "DirectionOfBodyStructure", - "DirectionOfCondition", - "DirectionOfExamination", - "DirectionOfTreatment", - "DosageOfMedication", - "FormOfMedication", - "FrequencyOfMedication", - "FrequencyOfTreatment", - "QualifierOfCondition", - "RelationOfExamination", - "RouteOfMedication", - "TimeOfCondition", - "TimeOfEvent", - "TimeOfExamination", - "TimeOfMedication", - "TimeOfTreatment", - "UnitOfCondition", - "UnitOfExamination", - "ValueOfCondition", - "ValueOfExamination" - ], - "x-ms-enum": { - "name": "relationType", - "modelAsString": true - } - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted relation." - }, - "entities": { - "description": "The entities in the relation.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareRelationEntity" - } - } - } - }, - "HealthcareAssertion": { - "type": "object", - "properties": { - "conditionality": { - "description": "Describes any conditionality on the entity.", - "type": "string", - "enum": [ - "hypothetical", - "conditional" - ], - "x-ms-enum": { - "name": "Conditionality", - "modelAsString": false - } - }, - "certainty": { - "description": "Describes the entities certainty and polarity.", - "type": "string", - "enum": [ - "positive", - "positivePossible", - "neutralPossible", - "negativePossible", - "negative" - ], - "x-ms-enum": { - "name": "Certainty", - "modelAsString": false - } - }, - "association": { - "description": "Describes if the entity is the subject of the text or if it describes someone else.", - "type": "string", - "enum": [ - "subject", - "other" - ], - "x-ms-enum": { - "name": "Association", - "modelAsString": false - } - } - } - }, - "HealthcareRelationEntity": { - "type": "object", - "required": [ - "ref", - "role" - ], - "properties": { - "ref": { - "description": "Reference link object, using a JSON pointer RFC 6901 (URI Fragment Identifier Representation), pointing to the entity .", - "type": "string" - }, - "role": { - "description": "Role of entity in the relationship. For example: 'CD20-positive diffuse large B-cell lymphoma' has the following entities with their roles in parenthesis: CD20 (GeneOrProtein), Positive (Expression), diffuse large B-cell lymphoma (Diagnosis).", - "type": "string" - } - } - }, - "HealthcareEntityLink": { - "type": "object", - "required": [ - "dataSource", - "id" - ], - "properties": { - "dataSource": { - "description": "Entity Catalog. Examples include: UMLS, CHV, MSH, etc.", - "type": "string" - }, - "id": { - "description": "Entity id in the given source catalog.", - "type": "string" - } - } - }, - "SentimentAnalysisTaskParameters": { - "type": "object", - "description": "Supported parameters for a Sentiment Analysis task.", - "properties": { - "opinionMining": { - "type": "boolean", - "default": false - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "SentimentAnalysisLROTask": { - "type": "object", - "description": "An object representing the task definition for a Sentiment Analysis task.", - "properties": { - "parameters": { - "$ref": "#/definitions/SentimentAnalysisTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "SentimentAnalysis" - }, - "SentimentTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/SentimentResponse" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "SentimentAnalysisResults" - }, - "SentimentResponse": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Sentiment analysis per document.", - "items": { - "allOf": [ - { - "$ref": "#/definitions/SentimentDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "SentimentDocumentResult": { - "type": "object", - "properties": { - "sentiment": { - "type": "string", - "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).", - "enum": [ - "positive", - "neutral", - "negative", - "mixed" - ], - "x-ms-enum": { - "name": "DocumentSentimentValue", - "modelAsString": false - } - }, - "confidenceScores": { - "description": "Document level sentiment confidence scores between 0 and 1 for each sentiment class.", - "$ref": "#/definitions/SentimentConfidenceScorePerLabel" - }, - "sentences": { - "type": "array", - "description": "Sentence level sentiment analysis.", - "items": { - "$ref": "#/definitions/SentenceSentiment" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "sentiment", - "confidenceScores", - "sentences" - ] - }, - "SentimentConfidenceScorePerLabel": { - "type": "object", - "required": [ - "positive", - "neutral", - "negative" - ], - "properties": { - "positive": { - "type": "number", - "format": "double", - "description": "Confidence score for positive sentiment" - }, - "neutral": { - "type": "number", - "format": "double", - "description": "Confidence score for neutral sentiment" - }, - "negative": { - "type": "number", - "format": "double", - "description": "Confidence score for negative sentiment" - } - }, - "description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative." - }, - "SentenceSentiment": { - "type": "object", - "required": [ - "text", - "sentiment", - "confidenceScores", - "offset", - "length" - ], - "properties": { - "text": { - "type": "string", - "description": "The sentence text." - }, - "sentiment": { - "type": "string", - "description": "The predicted Sentiment for the sentence.", - "enum": [ - "positive", - "neutral", - "negative" - ], - "x-ms-enum": { - "name": "SentenceSentimentValue", - "modelAsString": false - } - }, - "confidenceScores": { - "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes.", - "$ref": "#/definitions/SentimentConfidenceScorePerLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The sentence offset from the start of the document." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the sentence." - }, - "targets": { - "type": "array", - "description": "The array of sentence targets for the sentence.", - "items": { - "$ref": "#/definitions/SentenceTarget" - } - }, - "assessments": { - "type": "array", - "description": "The array of assessments for the sentence.", - "items": { - "$ref": "#/definitions/SentenceAssessment" - } - } - } - }, - "SentenceTarget": { - "type": "object", - "required": [ - "confidenceScores", - "length", - "offset", - "relations", - "sentiment", - "text" - ], - "properties": { - "sentiment": { - "type": "string", - "enum": [ - "positive", - "mixed", - "negative" - ], - "x-ms-enum": { - "name": "TokenSentimentValue", - "modelAsString": false - }, - "description": "Targeted sentiment in the sentence." - }, - "confidenceScores": { - "description": "Target sentiment confidence scores for the target in the sentence.", - "$ref": "#/definitions/TargetConfidenceScoreLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The target offset from the start of the sentence." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the target." - }, - "text": { - "type": "string", - "description": "The target text detected." - }, - "relations": { - "type": "array", - "description": "The array of either assessment or target objects which is related to the target.", - "items": { - "$ref": "#/definitions/TargetRelation" - } - } - } - }, - "SentenceAssessment": { - "type": "object", - "required": [ - "confidenceScores", - "isNegated", - "length", - "offset", - "sentiment", - "text" - ], - "properties": { - "sentiment": { - "type": "string", - "enum": [ - "positive", - "mixed", - "negative" - ], - "x-ms-enum": { - "name": "TokenSentimentValue", - "modelAsString": false - }, - "description": "Assessment sentiment in the sentence." - }, - "confidenceScores": { - "description": "Assessment sentiment confidence scores in the sentence.", - "$ref": "#/definitions/TargetConfidenceScoreLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The assessment offset from the start of the sentence." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the assessment." - }, - "text": { - "type": "string", - "description": "The assessment text detected." - }, - "isNegated": { - "type": "boolean", - "description": "The indicator representing if the assessment is negated." - } - } - }, - "TargetRelation": { - "type": "object", - "required": [ - "ref", - "relationType" - ], - "properties": { - "relationType": { - "type": "string", - "enum": [ - "assessment", - "target" - ], - "x-ms-enum": { - "name": "TargetRelationType", - "modelAsString": false - }, - "description": "The type related to the target." - }, - "ref": { - "type": "string", - "description": "The JSON pointer indicating the linked object." - } - } - }, - "TargetConfidenceScoreLabel": { - "type": "object", - "required": [ - "negative", - "positive" - ], - "properties": { - "positive": { - "type": "number", - "format": "double", - "description": "Confidence score for positive sentiment" - }, - "negative": { - "type": "number", - "format": "double", - "description": "Confidence score for negative sentiment" - } - }, - "description": "Represents the confidence scores across all sentiment classes: positive and negative." - }, - "EntitiesTaskParameters": { - "type": "object", - "description": "Supported parameters for an Entity Recognition task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "EntitiesLROTask": { - "type": "object", - "description": "An object representing the task definition for an Entities Recognition task.", - "properties": { - "parameters": { - "$ref": "#/definitions/EntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "EntityRecognition" - }, - "EntitiesTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityRecognitionResults" - }, - "EntitiesResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "$ref": "#/definitions/EntitiesResultWithDetectedLanguage" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "EntitiesResultWithDetectedLanguage": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/EntitiesDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - }, - "EntitiesDocumentResult": { - "type": "object", - "properties": { - "entities": { - "type": "array", - "description": "Recognized entities in the document.", - "items": { - "$ref": "#/definitions/EntityWithResolution" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "entities" - ] - }, - "Entity": { - "type": "object", - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ], - "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "type": "string", - "description": "Entity type." - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub type." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted entity." - } - } - }, - "EntityWithResolution": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Entity" - } - ], - "properties": { - "resolutions": { - "description": "The collection of entity resolution objects.", - "type": "array", - "items": { - "$ref": "#/definitions/BaseResolution" - } - } - } - }, - "EntityLinkingTaskParameters": { - "type": "object", - "description": "Supported parameters for an Entity Linking task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "EntityLinkingLROTask": { - "type": "object", - "description": "An object representing the task definition for an Entity Linking task.", - "properties": { - "parameters": { - "$ref": "#/definitions/EntityLinkingTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "EntityLinking" - }, - "EntityLinkingTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntityLinkingResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityLinkingResults" - }, - "EntityLinkingResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "$ref": "#/definitions/EntityLinkingResultWithDetectedLanguage" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "EntityLinkingResultWithDetectedLanguage": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/LinkedEntitiesDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - }, - "LinkedEntitiesDocumentResult": { - "type": "object", - "required": [ - "entities" - ], - "properties": { - "entities": { - "type": "array", - "description": "Recognized well known entities in the document.", - "items": { - "$ref": "#/definitions/LinkedEntity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ] - }, - "LinkedEntity": { - "type": "object", - "required": [ - "name", - "matches", - "language", - "url", - "dataSource" - ], - "properties": { - "name": { - "type": "string", - "description": "Entity Linking formal name." - }, - "matches": { - "type": "array", - "description": "List of instances this entity appears in the text.", - "items": { - "$ref": "#/definitions/Match" - } - }, - "language": { - "type": "string", - "description": "Language used in the data source." - }, - "id": { - "type": "string", - "description": "Unique identifier of the recognized entity from the data source." - }, - "url": { - "type": "string", - "description": "URL for the entity's page from the data source." - }, - "dataSource": { - "type": "string", - "description": "Data source used to extract entity linking, such as Wiki/Bing etc." - }, - "bingId": { - "type": "string", - "description": "Bing Entity Search API unique identifier of the recognized entity." - } - } - }, - "BaseResolution": { - "description": "The abstract base class for entity resolutions.", - "type": "object", - "discriminator": "resolutionKind", - "properties": { - "resolutionKind": { - "description": "The entity resolution object kind.", - "type": "string", - "enum": [ - "BooleanResolution", - "DateTimeResolution", - "NumberResolution", - "OrdinalResolution", - "SpeedResolution", - "WeightResolution", - "LengthResolution", - "VolumeResolution", - "AreaResolution", - "AgeResolution", - "InformationResolution", - "TemperatureResolution", - "CurrencyResolution", - "NumericRangeResolution", - "TemporalSpanResolution" - ], - "x-ms-enum": { - "name": "ResolutionKind", - "modelAsString": true - } - } - }, - "required": [ - "resolutionKind" - ] - }, - "QuantityResolution": { - "description": "Represents resolutions for quantities.", - "type": "object", - "properties": { - "value": { - "type": "number", - "format": "double", - "description": "The numeric value that the extracted text denotes." - } - }, - "required": [ - "value" - ] - }, - "AgeResolution": { - "description": "Represents the Age entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "AgeResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Year", - "Month", - "Week", - "Day" - ], - "x-ms-enum": { - "name": "AgeUnit", - "modelAsString": true - }, - "description": "The Age Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "VolumeResolution": { - "description": "Represents the volume entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "VolumeResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "CubicMeter", - "CubicCentimeter", - "CubicMillimeter", - "Hectoliter", - "Decaliter", - "Liter", - "Centiliter", - "Milliliter", - "CubicYard", - "CubicInch", - "CubicFoot", - "CubicMile", - "FluidOunce", - "Teaspoon", - "Tablespoon", - "Pint", - "Quart", - "Cup", - "Gill", - "Pinch", - "FluidDram", - "Barrel", - "Minim", - "Cord", - "Peck", - "Bushel", - "Hogshead" - ], - "x-ms-enum": { - "name": "VolumeUnit", - "modelAsString": true - }, - "description": "The Volume Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "SpeedResolution": { - "description": "Represents the speed entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "SpeedResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "MeterPerSecond", - "KilometerPerHour", - "KilometerPerMinute", - "KilometerPerSecond", - "MilePerHour", - "Knot", - "FootPerSecond", - "FootPerMinute", - "YardPerMinute", - "YardPerSecond", - "MeterPerMillisecond", - "CentimeterPerMillisecond", - "KilometerPerMillisecond" - ], - "x-ms-enum": { - "name": "SpeedUnit", - "modelAsString": true - }, - "description": "The speed Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "AreaResolution": { - "description": "Represents the area entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "AreaResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "SquareKilometer", - "SquareHectometer", - "SquareDecameter", - "SquareDecimeter", - "SquareMeter", - "SquareCentimeter", - "SquareMillimeter", - "SquareInch", - "SquareFoot", - "SquareMile", - "SquareYard", - "Acre" - ], - "x-ms-enum": { - "name": "AreaUnit", - "modelAsString": true - }, - "description": "The area Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "LengthResolution": { - "description": "Represents the length entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "LengthResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Kilometer", - "Hectometer", - "Decameter", - "Meter", - "Decimeter", - "Centimeter", - "Millimeter", - "Micrometer", - "Nanometer", - "Picometer", - "Mile", - "Yard", - "Inch", - "Foot", - "LightYear", - "Pt" - ], - "x-ms-enum": { - "name": "LengthUnit", - "modelAsString": true - }, - "description": "The length Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "InformationResolution": { - "description": "Represents the information (data) entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "InformationResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Bit", - "Kilobit", - "Megabit", - "Gigabit", - "Terabit", - "Petabit", - "Byte", - "Kilobyte", - "Megabyte", - "Gigabyte", - "Terabyte", - "Petabyte" - ], - "x-ms-enum": { - "name": "InformationUnit", - "modelAsString": true - }, - "description": "The information (data) Unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "TemperatureResolution": { - "description": "Represents the temperature entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "TemperatureResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Fahrenheit", - "Kelvin", - "Rankine", - "Celsius" - ], - "x-ms-enum": { - "name": "TemperatureUnit", - "modelAsString": true - }, - "description": "The temperature Unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "WeightResolution": { - "description": "Represents the weight entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "WeightResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Kilogram", - "Gram", - "Milligram", - "Gallon", - "MetricTon", - "Ton", - "Pound", - "Ounce", - "Grain", - "PennyWeight", - "LongTonBritish", - "ShortTonUS", - "ShortHundredWeightUS", - "Stone", - "Dram" - ], - "x-ms-enum": { - "name": "WeightUnit", - "modelAsString": true - }, - "description": "The weight Unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "CurrencyResolution": { - "description": "Represents the currency entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "CurrencyResolution", - "properties": { - "iso4217": { - "type": "string", - "description": "The alphabetic code based on another ISO standard, ISO 3166, which lists the codes for country names. The first two letters of the ISO 4217 three-letter code are the same as the code for the country name, and, where possible, the third letter corresponds to the first letter of the currency name." - }, - "value": { - "type": "number", - "format": "double", - "description": "The money amount captured in the extracted entity" - }, - "unit": { - "type": "string", - "description": "The unit of the amount captured in the extracted entity" - } - }, - "required": [ - "value", - "unit" - ] - }, - "BooleanResolution": { - "description": "A resolution for boolean expressions", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "BooleanResolution", - "properties": { - "value": { - "type": "boolean" - } - }, - "required": [ - "value" - ] - }, - "DateTimeResolution": { - "description": "A resolution for datetime entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "DateTimeResolution", - "properties": { - "timex": { - "$ref": "#/definitions/TimeExpression" - }, - "dateTimeSubKind": { - "type": "string", - "enum": [ - "Time", - "Date", - "DateTime", - "Duration", - "Set" - ], - "x-ms-enum": { - "name": "DateTimeSubKind", - "modelAsString": true - }, - "description": "The DateTime SubKind" - }, - "value": { - "type": "string", - "description": "The actual time that the extracted text denote." - }, - "modifier": { - "$ref": "#/definitions/TemporalModifier" - } - }, - "required": [ - "timex", - "dateTimeSubKind", - "value" - ] - }, - "NumberResolution": { - "description": "A resolution for numeric entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "NumberResolution", - "properties": { - "numberKind": { - "type": "string", - "enum": [ - "Integer", - "Decimal", - "Power", - "Fraction", - "Percent", - "Unspecified" - ], - "x-ms-enum": { - "name": "NumberKind", - "modelAsString": true - }, - "description": "The type of the extracted number entity." - }, - "value": { - "type": "number", - "format": "double", - "description": "A numeric representation of what the extracted text denotes." - } - }, - "required": [ - "numberKind", - "value" - ] - }, - "OrdinalResolution": { - "description": "A resolution for ordinal numbers entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "OrdinalResolution", - "properties": { - "offset": { - "type": "string", - "description": "The offset With respect to the reference (e.g., offset = -1 in \"show me the second to last\"" - }, - "relativeTo": { - "type": "string", - "enum": [ - "Current", - "End", - "Start" - ], - "x-ms-enum": { - "name": "RelativeTo", - "modelAsString": true - }, - "description": "The reference point that the ordinal number denotes." - }, - "value": { - "type": "string", - "description": "A simple arithmetic expression that the ordinal denotes." - } - }, - "required": [ - "offset", - "relativeTo", - "value" - ] - }, - "TemporalSpanResolution": { - "description": "represents the resolution of a date and/or time span.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "TemporalSpanResolution", - "properties": { - "begin": { - "$ref": "#/definitions/TimeExpression" - }, - "end": { - "$ref": "#/definitions/TimeExpression" - }, - "duration": { - "type": "string", - "description": "An optional duration value formatted based on the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)" - }, - "modifier": { - "$ref": "#/definitions/TemporalModifier" - }, - "timex": { - "type": "string", - "description": "An optional triplet containing the beginning, the end, and the duration all stated as ISO 8601 formatted strings." - } - } - }, - "NumericRangeResolution": { - "description": "represents the resolution of numeric intervals.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "NumericRangeResolution", - "properties": { - "rangeKind": { - "type": "string", - "enum": [ - "Number", - "Speed", - "Weight", - "Length", - "Volume", - "Area", - "Age", - "Information", - "Temperature", - "Currency" - ], - "x-ms-enum": { - "name": "RangeKind", - "modelAsString": true - }, - "description": "The kind of range that the resolution object represents." - }, - "minimum": { - "type": "number", - "format": "double", - "description": "The beginning value of the interval." - }, - "maximum": { - "type": "number", - "format": "double", - "description": "The ending value of the interval." - } - }, - "required": [ - "rangeKind", - "minimum", - "maximum" - ] - }, - "TemporalModifier": { - "type": "string", - "description": "An optional modifier of a date/time instance.", - "enum": [ - "AfterApprox", - "Before", - "BeforeStart", - "Approx", - "ReferenceUndefined", - "SinceEnd", - "AfterMid", - "Start", - "After", - "BeforeEnd", - "Until", - "End", - "Less", - "Since", - "AfterStart", - "BeforeApprox", - "Mid", - "More" - ], - "x-ms-enum": { - "name": "TemporalModifier", - "modelAsString": true - } - }, - "TimeExpression": { - "type": "string", - "description": "An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)" - }, - "Match": { - "type": "object", - "required": [ - "confidenceScore", - "text", - "offset", - "length" - ], - "properties": { - "confidenceScore": { - "type": "number", - "format": "double", - "description": "If a well known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned." - }, - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity match text." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity match text." - } - } - }, - "PiiTaskParameters": { - "type": "object", - "description": "Supported parameters for a PII Entities Recognition task.", - "properties": { - "domain": { - "$ref": "#/definitions/PiiDomain" - }, - "piiCategories": { - "$ref": "#/definitions/PiiCategories" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "PiiLROTask": { - "type": "object", - "description": "An object representing the task definition for a PII Entities Recognition task.", - "properties": { - "parameters": { - "$ref": "#/definitions/PiiTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "PiiEntityRecognition" - }, - "PiiTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/PiiResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "PiiEntityRecognitionResults" - }, - "PiiResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "$ref": "#/definitions/PIIResultWithDetectedLanguage" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "PIIResultWithDetectedLanguage": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/PiiEntitiesDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - }, - "PiiDomain": { - "type": "string", - "description": "The PII domain used for PII Entity Recognition.", - "default": "none", - "enum": [ - "phi", - "none" - ], - "x-ms-enum": { - "name": "PiiDomain", - "modelAsString": true, - "values": [ - { - "name": "phi", - "description": "Indicates that entities in the Personal Health Information domain should be redacted.", - "value": "phi" - }, - { - "name": "none", - "description": "Indicates that no domain is specified.", - "value": "none" - } - ] - } - }, - "PiiEntitiesDocumentResult": { - "type": "object", - "properties": { - "redactedText": { - "type": "string", - "description": "Returns redacted text." - }, - "entities": { - "type": "array", - "description": "Recognized entities in the document.", - "items": { - "$ref": "#/definitions/Entity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "redactedText", - "entities" - ] - }, - "PiiCategories": { - "description": "(Optional) describes the PII categories to return", - "items": { - "type": "string", - "x-ms-enum": { - "name": "PiiCategory", - "modelAsString": true - }, - "enum": [ - "ABARoutingNumber", - "ARNationalIdentityNumber", - "AUBankAccountNumber", - "AUDriversLicenseNumber", - "AUMedicalAccountNumber", - "AUPassportNumber", - "AUTaxFileNumber", - "AUBusinessNumber", - "AUCompanyNumber", - "ATIdentityCard", - "ATTaxIdentificationNumber", - "ATValueAddedTaxNumber", - "AzureDocumentDBAuthKey", - "AzureIAASDatabaseConnectionAndSQLString", - "AzureIoTConnectionString", - "AzurePublishSettingPassword", - "AzureRedisCacheString", - "AzureSAS", - "AzureServiceBusString", - "AzureStorageAccountKey", - "AzureStorageAccountGeneric", - "BENationalNumber", - "BENationalNumberV2", - "BEValueAddedTaxNumber", - "BRCPFNumber", - "BRLegalEntityNumber", - "BRNationalIDRG", - "BGUniformCivilNumber", - "CABankAccountNumber", - "CADriversLicenseNumber", - "CAHealthServiceNumber", - "CAPassportNumber", - "CAPersonalHealthIdentification", - "CASocialInsuranceNumber", - "CLIdentityCardNumber", - "CNResidentIdentityCardNumber", - "CreditCardNumber", - "HRIdentityCardNumber", - "HRNationalIDNumber", - "HRPersonalIdentificationNumber", - "HRPersonalIdentificationOIBNumberV2", - "CYIdentityCard", - "CYTaxIdentificationNumber", - "CZPersonalIdentityNumber", - "CZPersonalIdentityV2", - "DKPersonalIdentificationNumber", - "DKPersonalIdentificationV2", - "DrugEnforcementAgencyNumber", - "EEPersonalIdentificationCode", - "EUDebitCardNumber", - "EUDriversLicenseNumber", - "EUGPSCoordinates", - "EUNationalIdentificationNumber", - "EUPassportNumber", - "EUSocialSecurityNumber", - "EUTaxIdentificationNumber", - "FIEuropeanHealthNumber", - "FINationalID", - "FINationalIDV2", - "FIPassportNumber", - "FRDriversLicenseNumber", - "FRHealthInsuranceNumber", - "FRNationalID", - "FRPassportNumber", - "FRSocialSecurityNumber", - "FRTaxIdentificationNumber", - "FRValueAddedTaxNumber", - "DEDriversLicenseNumber", - "DEPassportNumber", - "DEIdentityCardNumber", - "DETaxIdentificationNumber", - "DEValueAddedNumber", - "GRNationalIDCard", - "GRNationalIDV2", - "GRTaxIdentificationNumber", - "HKIdentityCardNumber", - "HUValueAddedNumber", - "HUPersonalIdentificationNumber", - "HUTaxIdentificationNumber", - "INPermanentAccount", - "INUniqueIdentificationNumber", - "IDIdentityCardNumber", - "InternationalBankingAccountNumber", - "IEPersonalPublicServiceNumber", - "IEPersonalPublicServiceNumberV2", - "ILBankAccountNumber", - "ILNationalID", - "ITDriversLicenseNumber", - "ITFiscalCode", - "ITValueAddedTaxNumber", - "JPBankAccountNumber", - "JPDriversLicenseNumber", - "JPPassportNumber", - "JPResidentRegistrationNumber", - "JPSocialInsuranceNumber", - "JPMyNumberCorporate", - "JPMyNumberPersonal", - "JPResidenceCardNumber", - "LVPersonalCode", - "LTPersonalCode", - "LUNationalIdentificationNumberNatural", - "LUNationalIdentificationNumberNonNatural", - "MYIdentityCardNumber", - "MTIdentityCardNumber", - "MTTaxIDNumber", - "NLCitizensServiceNumber", - "NLCitizensServiceNumberV2", - "NLTaxIdentificationNumber", - "NLValueAddedTaxNumber", - "NZBankAccountNumber", - "NZDriversLicenseNumber", - "NZInlandRevenueNumber", - "NZMinistryOfHealthNumber", - "NZSocialWelfareNumber", - "NOIdentityNumber", - "PHUnifiedMultiPurposeIDNumber", - "PLIdentityCard", - "PLNationalID", - "PLNationalIDV2", - "PLPassportNumber", - "PLTaxIdentificationNumber", - "PLREGONNumber", - "PTCitizenCardNumber", - "PTCitizenCardNumberV2", - "PTTaxIdentificationNumber", - "ROPersonalNumericalCode", - "RUPassportNumberDomestic", - "RUPassportNumberInternational", - "SANationalID", - "SGNationalRegistrationIdentityCardNumber", - "SKPersonalNumber", - "SITaxIdentificationNumber", - "SIUniqueMasterCitizenNumber", - "ZAIdentificationNumber", - "KRResidentRegistrationNumber", - "ESDNI", - "ESSocialSecurityNumber", - "ESTaxIdentificationNumber", - "SQLServerConnectionString", - "SENationalID", - "SENationalIDV2", - "SEPassportNumber", - "SETaxIdentificationNumber", - "SWIFTCode", - "CHSocialSecurityNumber", - "TWNationalID", - "TWPassportNumber", - "TWResidentCertificate", - "THPopulationIdentificationCode", - "TRNationalIdentificationNumber", - "UKDriversLicenseNumber", - "UKElectoralRollNumber", - "UKNationalHealthNumber", - "UKNationalInsuranceNumber", - "UKUniqueTaxpayerNumber", - "USUKPassportNumber", - "USBankAccountNumber", - "USDriversLicenseNumber", - "USIndividualTaxpayerIdentification", - "USSocialSecurityNumber", - "UAPassportNumberDomestic", - "UAPassportNumberInternational", - "Organization", - "Email", - "URL", - "Age", - "PhoneNumber", - "IPAddress", - "Date", - "Person", - "Address", - "All", - "Default" - ] - }, - "type": "array", - "uniqueItems": true - }, - "ExtractiveSummarizationTaskParameters": { - "type": "object", - "description": "Supported parameters for an Extractive Summarization task.", - "properties": { - "sentenceCount": { - "type": "integer", - "default": 3 - }, - "sortBy": { - "$ref": "#/definitions/ExtractiveSummarizationSortingCriteria" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "ExtractiveSummarizationLROTask": { - "type": "object", - "description": "An object representing the task definition for an Extractive Summarization task.", - "properties": { - "parameters": { - "$ref": "#/definitions/ExtractiveSummarizationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "ExtractiveSummarization" - }, - "ExtractiveSummarizationResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "$ref": "#/definitions/ExtractedSummaryDocumentResultWithDetectedLanguage" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "ExtractiveSummarizationSortingCriteria": { - "type": "string", - "default": "Offset", - "description": "The sorting criteria to use for the results of Extractive Summarization.", - "enum": [ - "Offset", - "Rank" - ], - "x-ms-enum": { - "name": "ExtractiveSummarizationSortingCriteria", - "modelAsString": true, - "values": [ - { - "name": "Offset", - "description": "Indicates that results should be sorted in order of appearance in the text.", - "value": "Offset" - }, - { - "name": "Rank", - "description": "Indicates that results should be sorted in order of importance (i.e. rank score) according to the model.", - "value": "Rank" - } - ] - } - }, - "ExtractedSummaryDocumentResultWithDetectedLanguage": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ExtractedSummaryDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - }, - "ExtractedSummaryDocumentResult": { - "type": "object", - "properties": { - "sentences": { - "type": "array", - "description": "A ranked list of sentences representing the extracted summary.", - "items": { - "$ref": "#/definitions/ExtractedSummarySentence" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "sentences" - ] - }, - "ExtractedSummarySentence": { - "type": "object", - "required": [ - "text", - "rankScore", - "offset", - "length" - ], - "properties": { - "text": { - "type": "string", - "description": "The extracted sentence text." - }, - "rankScore": { - "type": "number", - "format": "double", - "description": "A double value representing the relevance of the sentence within the summary. Higher values indicate higher importance." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The sentence offset from the start of the document, based on the value of the parameter StringIndexType." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the sentence." - } - } - }, - "KeyPhraseTaskParameters": { - "type": "object", - "description": "Supported parameters for a Key Phrase Extraction task.", - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "KeyPhraseLROTask": { - "type": "object", - "description": "An object representing the task definition for a Key Phrase Extraction task.", - "properties": { - "parameters": { - "$ref": "#/definitions/KeyPhraseTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "KeyPhraseExtraction" - }, - "KeyPhraseTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/KeyPhraseResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "KeyPhraseExtractionResults" - }, - "KeyPhraseResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/KeyPhrasesDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "KeyPhrasesDocumentResult": { - "type": "object", - "properties": { - "keyPhrases": { - "type": "array", - "description": "A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.", - "items": { - "type": "string" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "keyPhrases" - ] - }, - "LanguageDetectionTaskParameters": { - "type": "object", - "description": "Supported parameters for a Language Detection task.", - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "LanguageDetectionTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/LanguageDetectionResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "LanguageDetectionResults" - }, - "LanguageDetectionResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "$ref": "#/definitions/LanguageDetectionDocumentResult" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "LanguageDetectionDocumentResult": { - "type": "object", - "properties": { - "detectedLanguage": { - "description": "Detected Language.", - "$ref": "#/definitions/DetectedLanguage" - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "detectedLanguage" - ] - }, - "DetectedLanguage": { - "type": "object", - "required": [ - "name", - "iso6391Name", - "confidenceScore" - ], - "properties": { - "name": { - "type": "string", - "description": "Long name of a detected language (e.g. English, French)." - }, - "iso6391Name": { - "type": "string", - "description": "A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr)." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true." - }, - "script": { - "type": "string", - "description": "Identifies the script of the input document.", - "enum": [ - "Latin" - ], - "x-ms-enum": { - "name": "ScriptKind", - "modelAsString": true - } - } - } - }, - "AnalyzeTextJobState": { - "allOf": [ - { - "$ref": "common.json#/definitions/JobState" - }, - { - "$ref": "#/definitions/TasksState" - }, - { - "$ref": "#/definitions/AnalyzeTextJobStatistics" - } - ] - }, - "Pagination": { - "properties": { - "nextLink": { - "type": "string" - } - }, - "type": "object" - }, - "AnalyzeTextJobStatistics": { - "properties": { - "statistics": { - "$ref": "common.json#/definitions/RequestStatistics" - } - }, - "type": "object" - }, - "TasksState": { - "properties": { - "tasks": { - "properties": { - "completed": { - "type": "integer" - }, - "failed": { - "type": "integer" - }, - "inProgress": { - "type": "integer" - }, - "total": { - "type": "integer" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - } - }, - "required": [ - "total", - "completed", - "failed", - "inProgress" - ], - "type": "object" - } - }, - "required": [ - "tasks" - ], - "type": "object" - }, - "AnalyzeTextLROResult": { - "type": "object", - "discriminator": "kind", - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextLROResultsKind" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskState" - }, - { - "$ref": "common.json#/definitions/TaskIdentifier" - } - ], - "required": [ - "kind" - ] - }, - "EntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityRecognitionLROResults" - }, - "CustomEntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomEntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomEntityRecognitionLROResults" - }, - "CustomSingleLabelClassificationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomLabelClassificationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomSingleLabelClassificationLROResults" - }, - "CustomMultiLabelClassificationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomLabelClassificationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomMultiLabelClassificationLROResults" - }, - "EntityLinkingLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntityLinkingResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityLinkingLROResults" - }, - "PiiEntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/PiiResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "PiiEntityRecognitionLROResults" - }, - "ExtractiveSummarizationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/ExtractiveSummarizationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "ExtractiveSummarizationLROResults" - }, - "HealthcareLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/HealthcareResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "HealthcareLROResults" - }, - "SentimentLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/SentimentResponse" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "SentimentAnalysisLROResults" - }, - "KeyPhraseExtractionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/KeyPhraseResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "KeyPhraseExtractionLROResults" - }, - "DocumentResponse": { - "type": "object", - "properties": {} - }, - "DocumentResult": { - "type": "object", - "required": [ - "id", - "warnings" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique, non-empty document identifier." - }, - "warnings": { - "type": "array", - "description": "Warnings encountered while processing document.", - "items": { - "$ref": "#/definitions/DocumentWarning" - } - }, - "statistics": { - "description": "if showStats=true was specified in the request this field will contain information about the document payload.", - "$ref": "#/definitions/DocumentStatistics" - } - } - }, - "DocumentDetectedLanguage": { - "type": "object", - "properties": { - "detectedLanguage": { - "$ref": "#/definitions/DetectedLanguage", - "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." - } - } - }, - "DocumentDetectedLanguageString": { - "type": "object", - "properties": { - "detectedLanguage": { - "type": "string", - "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." - } - } - }, - "DocumentError": { - "type": "object", - "required": [ - "id", - "error" - ], - "properties": { - "id": { - "type": "string", - "description": "Document Id." - }, - "error": { - "type": "object", - "description": "Document Error.", - "$ref": "common.json#/definitions/Error" - } - } - }, - "DocumentWarning": { - "type": "object", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "LongWordsInDocument", - "DocumentTruncated" - ], - "x-ms-enum": { - "name": "WarningCodeValue", - "modelAsString": true - }, - "description": "Error code." - }, - "message": { - "type": "string", - "description": "Warning message." - }, - "targetRef": { - "type": "string", - "description": "A JSON pointer reference indicating the target object." - } - } - }, - "DocumentStatistics": { - "type": "object", - "required": [ - "charactersCount", - "transactionsCount" - ], - "properties": { - "charactersCount": { - "type": "integer", - "format": "int32", - "description": "Number of text elements recognized in the document." - }, - "transactionsCount": { - "type": "integer", - "format": "int32", - "description": "Number of transactions for the document." - } - }, - "description": "if showStats=true was specified in the request this field will contain information about the document payload." - }, - "DocumentRequestStatistics": { - "type": "object", - "required": [ - "documentsCount", - "validDocumentsCount", - "erroneousDocumentsCount" - ], - "properties": { - "documentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of documents submitted in the request." - }, - "validDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." - }, - "erroneousDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/RequestStatistics" - } - ], - "description": "if showStats=true was specified in the request this field will contain information about the document request payload." - }, - "MultiLanguageInput": { - "type": "object", - "description": "Contains an input document to be analyzed by the service.", - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "A unique, non-empty document identifier." - }, - "text": { - "type": "string", - "description": "The input text to process." - }, - "language": { - "type": "string", - "description": "(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. For Auto Language Detection, use \"auto\". If not set, use \"en\" for English as default." - } - } - }, - "LanguageInput": { - "type": "object", - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique, non-empty document identifier." - }, - "text": { - "type": "string" - }, - "countryHint": { - "type": "string" - } - } - }, - "AbstractiveSummarizationLROTask": { - "type": "object", - "description": "An object representing the task definition for an Abstractive Summarization task.", - "required": [ - "parameters" - ], - "properties": { - "parameters": { - "$ref": "#/definitions/AbstractiveSummarizationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "AbstractiveSummarization" - }, - "AbstractiveSummarizationTaskParameters": { - "type": "object", - "description": "Supported parameters for the pre-build Abstractive Summarization task.", - "allOf": [ - { - "$ref": "common.json#/definitions/AbstractiveSummarizationTaskParametersBase" - }, - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "AbstractiveSummarizationLROResult": { - "type": "object", - "description": "An object representing the results for an Abstractive Summarization task.", - "properties": { - "results": { - "$ref": "#/definitions/AbstractiveSummarizationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "AbstractiveSummarizationLROResults" - }, - "AbstractiveSummarizationResultBase": { - "type": "object", - "description": "An object representing the summarization results of each document.", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "$ref": "#/definitions/AbstractiveSummaryDocumentResultWithDetectedLanguage" - } - } - }, - "required": [ - "documents" - ] - }, - "AbstractiveSummarizationResult": { - "type": "object", - "description": "An object representing the pre-build summarization results of each document.", - "allOf": [ - { - "$ref": "#/definitions/AbstractiveSummarizationResultBase" - }, - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "AbstractiveSummaryDocumentResultWithDetectedLanguage": { - "type": "object", - "description": "An object representing the summarization result of a single document with detected language.", - "allOf": [ - { - "$ref": "#/definitions/AbstractiveSummaryDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - }, - "AbstractiveSummaryDocumentResult": { - "type": "object", - "description": "An object representing the summarization result of a single document.", - "properties": { - "summaries": { - "type": "array", - "description": "A list of abstractive summaries.", - "items": { - "$ref": "#/definitions/AbstractiveSummary" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "summaries" - ] - }, - "AbstractiveSummary": { - "type": "object", - "description": "An object representing a single summary with context for given document.", - "properties": { - "text": { - "type": "string", - "description": "The text of the summary." - }, - "contexts": { - "type": "array", - "description": "The context list of the summary.", - "items": { - "$ref": "common.json#/definitions/SummaryContext" - } - } - }, - "required": [ - "text" - ] - } - }, - "parameters": {} -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/common.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/common.json deleted file mode 100644 index 29bc08014939..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/common.json +++ /dev/null @@ -1,929 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2022-10-01-preview" - }, - "paths": {}, - "definitions": { - "ErrorResponse": { - "type": "object", - "description": "Error response.", - "additionalProperties": false, - "properties": { - "error": { - "description": "The error object.", - "$ref": "#/definitions/Error" - } - }, - "required": [ - "error" - ] - }, - "Error": { - "type": "object", - "description": "The error object.", - "additionalProperties": true, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/ErrorCode" - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - }, - "target": { - "type": "string", - "description": "The target of the error." - }, - "details": { - "type": "array", - "description": "An array of details about specific errors that led to this reported error.", - "items": { - "$ref": "#/definitions/Error" - } - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "InnerErrorModel": { - "type": "object", - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", - "additionalProperties": false, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/InnerErrorCode" - }, - "message": { - "type": "string", - "description": "Error message." - }, - "details": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Error details." - }, - "target": { - "type": "string", - "description": "Error target." - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "ErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "ErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidArgument", - "Unauthorized", - "Forbidden", - "NotFound", - "ProjectNotFound", - "OperationNotFound", - "AzureCognitiveSearchNotFound", - "AzureCognitiveSearchIndexNotFound", - "TooManyRequests", - "AzureCognitiveSearchThrottling", - "AzureCognitiveSearchIndexLimitReached", - "InternalServerError", - "ServiceUnavailable", - "Timeout", - "QuotaExceeded", - "Conflict", - "Warning" - ] - }, - "InnerErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "InnerErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidParameterValue", - "KnowledgeBaseNotFound", - "AzureCognitiveSearchNotFound", - "AzureCognitiveSearchThrottling", - "ExtractionFailure", - "InvalidRequestBodyFormat", - "EmptyRequest", - "MissingInputDocuments", - "InvalidDocument", - "ModelVersionIncorrect", - "InvalidDocumentBatch", - "UnsupportedLanguageCode", - "InvalidCountryHint" - ] - }, - "Language": { - "type": "string", - "description": "Language of the text records. This is BCP-47 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." - }, - "StringIndexType": { - "type": "string", - "description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.", - "default": "TextElements_v8", - "enum": [ - "TextElements_v8", - "UnicodeCodePoint", - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "TextElements_v8", - "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." - }, - { - "value": "UnicodeCodePoint", - "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." - }, - { - "value": "Utf16CodeUnit", - "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - } - }, - "TaskState": { - "description": "Returns the current state of the task.", - "properties": { - "lastUpdateDateTime": { - "description": "The last updated time in UTC for the task.", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The status of the task at the mentioned last update time.", - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "State" - } - } - }, - "required": [ - "status", - "lastUpdateDateTime" - ], - "type": "object" - }, - "TaskIdentifier": { - "type": "object", - "description": "Base task object.", - "properties": { - "taskName": { - "type": "string" - } - } - }, - "TaskParameters": { - "type": "object", - "description": "Base parameters object for a text analysis task.", - "properties": { - "loggingOptOut": { - "type": "boolean", - "default": false - } - } - }, - "PreBuiltTaskParameters": { - "type": "object", - "description": "Parameters object for a text analysis task using pre-built models.", - "properties": { - "modelVersion": { - "type": "string", - "default": "latest" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - } - ] - }, - "JobState": { - "properties": { - "displayName": { - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "type": "string" - }, - "jobId": { - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { - "enum": [ - "notStarted", - "running", - "succeeded", - "partiallyCompleted", - "failed", - "cancelled", - "cancelling" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "State" - } - }, - "errors": { - "items": { - "$ref": "#/definitions/Error" - }, - "type": "array" - }, - "nextLink": { - "type": "string" - } - }, - "required": [ - "jobId", - "lastUpdatedDateTime", - "createdDateTime", - "status" - ] - }, - "JobErrors": { - "properties": { - "errors": { - "items": { - "$ref": "#/definitions/Error" - }, - "type": "array" - } - }, - "type": "object" - }, - "InputError": { - "type": "object", - "description": "Contains details of errors encountered during a job execution.", - "required": [ - "id", - "error" - ], - "properties": { - "id": { - "type": "string", - "description": "The ID of the input." - }, - "error": { - "type": "object", - "description": "Error encountered.", - "$ref": "#/definitions/Error" - } - } - }, - "InputWarning": { - "type": "object", - "description": "Contains details of warnings encountered during a job execution.", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "description": "Warning code." - }, - "message": { - "type": "string", - "description": "Warning message." - }, - "targetRef": { - "type": "string", - "description": "A JSON pointer reference indicating the target object." - } - } - }, - "RequestStatistics": { - "type": "object", - "required": [ - "documentsCount", - "validDocumentsCount", - "erroneousDocumentsCount", - "transactionsCount" - ], - "properties": { - "documentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of documents submitted in the request." - }, - "validDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." - }, - "erroneousDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." - }, - "transactionsCount": { - "type": "integer", - "format": "int64", - "description": "Number of transactions for the request." - } - }, - "additionalProperties": true, - "description": "if showStats=true was specified in the request this field will contain information about the request payload." - }, - "PreBuiltResult": { - "properties": { - "errors": { - "type": "array", - "description": "Errors by document id.", - "items": { - "$ref": "#/definitions/InputError" - } - }, - "statistics": { - "$ref": "#/definitions/RequestStatistics" - }, - "modelVersion": { - "type": "string", - "description": "This field indicates which model is used for scoring." - } - }, - "required": [ - "errors", - "modelVersion" - ] - }, - "AnswersResult": { - "type": "object", - "description": "Represents List of Question Answers.", - "additionalProperties": false, - "properties": { - "answers": { - "type": "array", - "description": "Represents Answer Result list.", - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswer" - } - } - } - }, - "KnowledgeBaseAnswer": { - "type": "object", - "description": "Represents knowledge base answer.", - "additionalProperties": false, - "properties": { - "questions": { - "type": "array", - "description": "List of questions associated with the answer.", - "items": { - "type": "string" - } - }, - "answer": { - "type": "string", - "description": "Answer text." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidence", - "description": "Answer confidence score, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "id": { - "type": "integer", - "x-ms-client-name": "qnaId", - "description": "ID of the QnA result.", - "format": "int32" - }, - "source": { - "type": "string", - "description": "Source of QnA result." - }, - "metadata": { - "type": "object", - "description": "Metadata associated with the answer, useful to categorize or filter question answers.", - "additionalProperties": { - "type": "string" - } - }, - "dialog": { - "type": "object", - "$ref": "#/definitions/KnowledgeBaseAnswerDialog" - }, - "answerSpan": { - "type": "object", - "x-ms-client-name": "shortAnswer", - "description": "Answer span object of QnA with respect to user's question.", - "$ref": "#/definitions/AnswerSpan" - } - } - }, - "KnowledgeBaseAnswerDialog": { - "type": "object", - "description": "Dialog associated with Answer.", - "properties": { - "isContextOnly": { - "type": "boolean", - "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as search result for queries without context; otherwise, if false, ignores context and includes this QnA in search result." - }, - "prompts": { - "type": "array", - "description": "List of prompts associated with the answer.", - "maxItems": 20, - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswerPrompt" - } - } - } - }, - "KnowledgeBaseAnswerPrompt": { - "type": "object", - "description": "Prompt for an answer.", - "properties": { - "displayOrder": { - "type": "integer", - "description": "Index of the prompt - used in ordering of the prompts.", - "format": "int32" - }, - "qnaId": { - "type": "integer", - "description": "QnA ID corresponding to the prompt.", - "format": "int32" - }, - "displayText": { - "type": "string", - "description": "Text displayed to represent a follow up question prompt.", - "maxLength": 200 - } - } - }, - "AnswerSpan": { - "type": "object", - "description": "Answer span object of QnA.", - "additionalProperties": false, - "properties": { - "text": { - "type": "string", - "description": "Predicted text of answer span." - }, - "confidenceScore": { - "type": "number", - "x-ms-client-name": "confidence", - "description": "Predicted score of answer span, value ranges from 0 to 1.", - "format": "double", - "maximum": 1, - "minimum": 0 - }, - "offset": { - "type": "integer", - "description": "The answer span offset from the start of answer.", - "format": "int32" - }, - "length": { - "type": "integer", - "description": "The length of the answer span.", - "format": "int32" - } - } - }, - "AnswersOptions": { - "type": "object", - "description": "Parameters to query a knowledge base.", - "additionalProperties": false, - "properties": { - "qnaId": { - "type": "integer", - "description": "Exact QnA ID to fetch from the knowledge base, this field takes priority over question.", - "format": "int32" - }, - "question": { - "type": "string", - "description": "User question to query against the knowledge base." - }, - "top": { - "type": "integer", - "description": "Max number of answers to be returned for the question.", - "format": "int32" - }, - "userId": { - "type": "string", - "description": "Unique identifier for the user." - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidenceThreshold", - "description": "Minimum threshold score for answers, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "context": { - "x-ms-client-name": "answerContext", - "description": "Context object with previous QnA's information.", - "$ref": "#/definitions/KnowledgeBaseAnswerContext" - }, - "rankerType": { - "type": "string", - "x-ms-client-name": "rankerKind", - "description": "Type of ranker to be used.", - "x-ms-enum": { - "name": "RankerKind", - "modelAsString": true, - "values": [ - { - "value": "QuestionOnly", - "description": "Question only ranker." - }, - { - "value": "Default", - "description": "Default ranker." - } - ] - }, - "enum": [ - "Default", - "QuestionOnly" - ] - }, - "filters": { - "description": "Filter QnAs based on given metadata list and knowledge base sources.", - "$ref": "#/definitions/QueryFilters" - }, - "answerSpanRequest": { - "x-ms-client-name": "shortAnswerOptions", - "description": "To configure Answer span prediction feature.", - "$ref": "#/definitions/ShortAnswerOptions" - }, - "includeUnstructuredSources": { - "type": "boolean", - "description": "(Optional) Flag to enable Query over Unstructured Sources." - } - } - }, - "KnowledgeBaseAnswerContext": { - "type": "object", - "description": "Context object with previous QnA's information.", - "additionalProperties": false, - "required": [ - "previousQnaId" - ], - "properties": { - "previousQnaId": { - "type": "integer", - "description": "Previous turn top answer result QnA ID.", - "format": "int32" - }, - "previousUserQuery": { - "type": "string", - "x-ms-client-name": "previousQuestion", - "description": "Previous user query." - } - } - }, - "QueryFilters": { - "type": "object", - "description": "filters over knowledge base.", - "additionalProperties": false, - "properties": { - "metadataFilter": { - "type": "object", - "$ref": "#/definitions/MetadataFilter" - }, - "sourceFilter": { - "type": "object", - "$ref": "#/definitions/SourceFilter" - }, - "logicalOperation": { - "type": "string", - "description": "Logical operation used to join metadata filter with source filter.", - "$ref": "#/definitions/LogicalOperationKind", - "default": "AND" - } - } - }, - "MetadataFilter": { - "type": "object", - "description": "Find QnAs that are associated with the given list of metadata.", - "additionalProperties": false, - "properties": { - "metadata": { - "type": "array", - "items": { - "$ref": "#/definitions/MetadataRecord" - } - }, - "logicalOperation": { - "type": "string", - "description": "Operation used to join metadata filters.", - "$ref": "#/definitions/LogicalOperationKind", - "default": "AND" - } - } - }, - "MetadataRecord": { - "type": "object", - "description": "Object to provide the key value pair for each metadata.", - "additionalProperties": false, - "required": [ - "key", - "value" - ], - "properties": { - "key": { - "type": "string", - "description": "Metadata Key from Metadata dictionary used in the QnA." - }, - "value": { - "type": "string", - "description": "Metadata Value from Metadata dictionary used in the QnA." - } - } - }, - "SourceFilter": { - "type": "array", - "description": "Find QnAs that are associated with any of the given list of sources in knowledge base.", - "items": { - "type": "string" - } - }, - "LogicalOperationKind": { - "type": "string", - "description": "Set to 'OR' or 'AND' for using corresponding logical operation.", - "x-ms-enum": { - "name": "LogicalOperationKind", - "modelAsString": true - }, - "enum": [ - "AND", - "OR" - ] - }, - "ShortAnswerOptions": { - "type": "object", - "description": "To configure Answer span prediction feature.", - "additionalProperties": false, - "required": [ - "enable" - ], - "properties": { - "enable": { - "type": "boolean", - "description": "Enable or disable Answer Span prediction.", - "enum": [ - true - ], - "x-ms-enum": { - "name": "enable", - "modelAsString": false - } - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidenceThreshold", - "description": "Minimum threshold score required to include an answer span, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "topAnswersWithSpan": { - "type": "integer", - "x-ms-client-name": "top", - "description": "Number of Top answers to be considered for span prediction from 1 to 10.", - "format": "int32", - "maximum": 10, - "minimum": 1 - } - } - }, - "Sentiment": { - "type": "string", - "description": "Predicted sentiment.", - "enum": [ - "positive", - "neutral", - "negative", - "mixed" - ], - "x-ms-enum": { - "name": "TextSentiment", - "modelAsString": true, - "values": [ - { - "value": "positive", - "description": "Positive sentiment." - }, - { - "value": "neutral", - "description": "Neutral sentiment." - }, - { - "value": "negative", - "description": "Negative sentiment." - }, - { - "value": "mixed", - "description": "Mixed sentiment." - } - ] - } - }, - "SentimentConfidenceScores": { - "type": "object", - "required": [ - "positive", - "neutral", - "negative" - ], - "properties": { - "positive": { - "type": "number", - "format": "double", - "description": "Confidence score for positive sentiment" - }, - "neutral": { - "type": "number", - "format": "double", - "description": "Confidence score for neutral sentiment" - }, - "negative": { - "type": "number", - "format": "double", - "description": "Confidence score for negative sentiment" - } - }, - "description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative." - }, - "AbstractiveSummarizationTaskParametersBase": { - "type": "object", - "description": "Supported parameters for an Abstractive Summarization task.", - "properties": { - "sentenceCount": { - "type": "integer", - "format": "int32", - "description": "It controls the approximate number of sentences in the output summaries." - }, - "stringIndexType": { - "$ref": "#/definitions/StringIndexType" - } - } - }, - "SummaryContext": { - "type": "object", - "description": "The context of the summary.", - "required": [ - "offset", - "length" - ], - "properties": { - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the context. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the context. Use of different 'stringIndexType' values can affect the length returned." - } - } - } - }, - "parameters": { - "Endpoint": { - "name": "Endpoint", - "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - "ProjectNameQueryParameter": { - "name": "projectName", - "in": "query", - "required": true, - "type": "string", - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "ProjectNamePathParameter": { - "name": "projectName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 100, - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNameQueryParameter": { - "name": "deploymentName", - "in": "query", - "required": true, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNamePathParameter": { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - }, - "TopParameter": { - "name": "top", - "in": "query", - "description": "The maximum number of resources to return from the collection.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "SkipParameter": { - "name": "skip", - "in": "query", - "description": "An offset into the collection of the first resource to be returned.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "MaxPageSizeParameter": { - "name": "maxpagesize", - "in": "query", - "description": "The maximum number of resources to include in a single response.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "ShowStats": { - "name": "showStats", - "in": "query", - "description": "(Optional) if set to true, response will contain request and document level statistics.", - "type": "boolean", - "required": false, - "x-ms-parameter-location": "method" - }, - "JobId": { - "description": "Job ID", - "format": "uuid", - "in": "path", - "name": "jobId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json deleted file mode 100644 index 65b82399ccf0..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "body": { - "resourcesMetadata": [ - { - "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "customDomain": "lang-test-weu.cognitiveservices.azure.com", - "region": "westeurope" - }, - { - "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", - "customDomain": "lang-test-eus.cognitiveservices.azure.com", - "region": "eastus" - } - ] - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/resources/assign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json deleted file mode 100644 index 8c66c5072fb9..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json deleted file mode 100644 index f73b88a20429..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/merge-patch+json", - "api-version": "2022-10-01-preview", - "projectName": "myproject", - "body": { - "projectName": "myproject", - "language": "en", - "projectKind": "Conversation", - "description": "This is a sample conversation project.", - "multilingual": false - } - }, - "responses": { - "201": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "projectKind": "Conversation", - "projectName": "myproject", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - } - }, - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "Conversation", - "projectName": "myproject", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json deleted file mode 100644 index a1a56e9986a7..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "deploymentName": "staging" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json deleted file mode 100644 index fbe02148e57c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "deploymentName": "staging", - "body": { - "assignedResourceIds": [ - "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" - ] - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/delete-from-resources/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json deleted file mode 100644 index a2fd77af31ba..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model2" - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json deleted file mode 100644 index d5f59c5535a3..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "myproject" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json deleted file mode 100644 index 9380894258e5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "deploymentName": "production", - "body": { - "trainedModelLabel": "29886710a2ae49259d62cffca977db66", - "assignedResourceIds": [ - "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus" - ] - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json deleted file mode 100644 index bf7f74e9a6c3..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "stringIndexType": "Utf16CodeUnit" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json deleted file mode 100644 index 92883355a4be..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetDeleteDeploymentFromResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetDeleteDeploymentFromResourcesStatus.json deleted file mode 100644 index 99a9068739f5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetDeleteDeploymentFromResourcesStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "deploymentName": "production", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json deleted file mode 100644 index c0d79c186170..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "deploymentName": "staging" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "deploymentName": "staging", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T15:53:04Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-15-preview", - "assignedResources": [ - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "region": "westeurope" - }, - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", - "region": "eastus" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json deleted file mode 100644 index 99a9068739f5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "deploymentName": "production", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json deleted file mode 100644 index 2bf470635ffa..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "resultUrl": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2022-10-01-preview", - "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", - "createdDateTime": "2022-04-18T15:23:07Z", - "lastUpdatedDateTime": "2022-04-18T15:23:08Z", - "expirationDateTime": "2022-04-25T15:23:07Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json deleted file mode 100644 index 1d15fee25fea..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", - "createdDateTime": "2022-04-18T15:17:20Z", - "lastUpdatedDateTime": "2022-04-18T15:17:22Z", - "expirationDateTime": "2022-04-25T15:17:20Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json deleted file mode 100644 index 38e4532829c6..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:45:48Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "running" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json deleted file mode 100644 index 0386b16946be..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "label": "model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49Z", - "lastTrainingDurationInSeconds": 186, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json deleted file mode 100644 index 56391b74b422..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json +++ /dev/null @@ -1,284 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1", - "stringIndexType": "Utf16CodeUnit", - "maxpagesize": 10 - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "text": "send the email", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [], - "predictedEntities": [] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "send a mail to daniel", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 15, - "length": 6 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 15, - "length": 6 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "i forgot to add an important part to that email to james . please set it up to edit", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 51, - "length": 5 - } - ], - "predictedEntities": [ - { - "category": "Category", - "offset": 19, - "length": 9 - }, - { - "category": "ContactName", - "offset": 51, - "length": 5 - } - ] - }, - "intentsResult": { - "expectedIntent": "AddMore", - "predictedIntent": "AddMore" - } - }, - { - "text": "send email to a and tian", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 14, - "length": 1 - }, - { - "category": "ContactName", - "offset": 20, - "length": 4 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 14, - "length": 1 - }, - { - "category": "ContactName", - "offset": 20, - "length": 4 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "send thomas an email", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 5, - "length": 6 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 5, - "length": 6 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "i need to add more to the email message i am sending to vincent", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 56, - "length": 7 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 56, - "length": 7 - } - ] - }, - "intentsResult": { - "expectedIntent": "AddMore", - "predictedIntent": "AddMore" - } - }, - { - "text": "send an email to lily roth and abc123@microsoft.com", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 17, - "length": 9 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 17, - "length": 9 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "i need to add something else to my email to cheryl", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 44, - "length": 6 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 44, - "length": 6 - } - ] - }, - "intentsResult": { - "expectedIntent": "AddMore", - "predictedIntent": "AddMore" - } - }, - { - "text": "send an email to larry , joseph and billy larkson", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 17, - "length": 5 - }, - { - "category": "ContactName", - "offset": 25, - "length": 6 - }, - { - "category": "ContactName", - "offset": 36, - "length": 13 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 17, - "length": 5 - }, - { - "category": "ContactName", - "offset": 25, - "length": 6 - }, - { - "category": "ContactName", - "offset": 36, - "length": 13 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "send mail to dorothy", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 13, - "length": 7 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 13, - "length": 7 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - } - ], - "nextLink": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2022-10-01-preview&top=2147483637&skip={maxpagesize}&maxpagesize={maxpagesize}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json deleted file mode 100644 index d629e9f9298f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json +++ /dev/null @@ -1,526 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "entitiesEvaluation": { - "confusionMatrix": { - "Attachment": { - "Attachment": { - "normalizedValue": 100.0, - "rawValue": 3.0 - } - }, - "Category": { - "Category": { - "normalizedValue": 91.666664, - "rawValue": 11.0 - }, - "$none": { - "normalizedValue": 8.333333, - "rawValue": 1.0 - } - }, - "ContactName": { - "ContactName": { - "normalizedValue": 91.666664, - "rawValue": 22.0 - }, - "SenderName": { - "normalizedValue": 4.1666665, - "rawValue": 1.0 - }, - "$none": { - "normalizedValue": 4.1666665, - "rawValue": 1.0 - } - }, - "Date": { - "Date": { - "normalizedValue": 100.0, - "rawValue": 2.0 - } - }, - "EmailSubject": { - "EmailSubject": { - "normalizedValue": 93.33333, - "rawValue": 9.333334 - }, - "$none": { - "normalizedValue": 6.6666665, - "rawValue": 0.6666667 - } - }, - "FromRelationshipName": { - "FromRelationshipName": { - "normalizedValue": 100.0, - "rawValue": 1.0 - } - }, - "Line": { - "Line": { - "normalizedValue": 100.0, - "rawValue": 2.0 - } - }, - "Message": { - "Message": { - "normalizedValue": 81.2063, - "rawValue": 6.496504 - }, - "EmailSubject": { - "normalizedValue": 7.43007, - "rawValue": 0.5944056 - }, - "$none": { - "normalizedValue": 9.120047, - "rawValue": 0.7296037 - }, - "Date": { - "normalizedValue": 2.2435899, - "rawValue": 0.17948718 - } - }, - "OrderReference": { - "OrderReference": { - "normalizedValue": 100.0, - "rawValue": 17.0 - } - }, - "PositionReference": { - "$none": { - "normalizedValue": 100.0, - "rawValue": 1.0 - } - }, - "RelationshipName": { - "RelationshipName": { - "normalizedValue": 66.666664, - "rawValue": 2.0 - }, - "$none": { - "normalizedValue": 33.333332, - "rawValue": 1.0 - } - }, - "SearchTexts": { - "SearchTexts": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "SenderName": { - "SenderName": { - "normalizedValue": 88.888885, - "rawValue": 8.0 - }, - "ContactName": { - "normalizedValue": 11.111111, - "rawValue": 1.0 - } - }, - "Time": { - "$none": { - "normalizedValue": 100.0, - "rawValue": 2.0 - } - }, - "$none": { - "$none": { - "normalizedValue": 99.739265, - "rawValue": 162.575 - }, - "Category": { - "normalizedValue": 0.2607362, - "rawValue": 0.425 - } - } - }, - "entities": { - "ContactName": { - "f1": 0.9361702799797058, - "precision": 0.95652174949646, - "recall": 0.9166666865348816, - "truePositiveCount": 22, - "trueNegativeCount": 0, - "falsePositiveCount": 1, - "falseNegativeCount": 2 - }, - "Category": { - "f1": 0.8799999952316284, - "precision": 0.8461538553237915, - "recall": 0.9166666865348816, - "truePositiveCount": 11, - "trueNegativeCount": 0, - "falsePositiveCount": 2, - "falseNegativeCount": 1 - }, - "SenderName": { - "f1": 0.8888888955116272, - "precision": 0.8888888955116272, - "recall": 0.8888888955116272, - "truePositiveCount": 8, - "trueNegativeCount": 0, - "falsePositiveCount": 1, - "falseNegativeCount": 1 - }, - "EmailSubject": { - "f1": 0.8181817531585693, - "precision": 0.75, - "recall": 0.8999999761581421, - "truePositiveCount": 9, - "trueNegativeCount": 0, - "falsePositiveCount": 3, - "falseNegativeCount": 1 - }, - "Message": { - "f1": 0.75, - "precision": 0.75, - "recall": 0.75, - "truePositiveCount": 6, - "trueNegativeCount": 0, - "falsePositiveCount": 2, - "falseNegativeCount": 2 - }, - "Date": { - "f1": 0.800000011920929, - "precision": 0.6666666865348816, - "recall": 1.0, - "truePositiveCount": 2, - "trueNegativeCount": 0, - "falsePositiveCount": 1, - "falseNegativeCount": 0 - }, - "OrderReference": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 17, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "SearchTexts": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Attachment": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 3, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "RelationshipName": { - "f1": 0.800000011920929, - "precision": 1.0, - "recall": 0.6666666865348816, - "truePositiveCount": 2, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 1 - }, - "Line": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 2, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Time": { - "f1": 0.0, - "precision": 0.0, - "recall": 0.0, - "truePositiveCount": 0, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 2 - }, - "FromRelationshipName": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 1, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "PositionReference": { - "f1": 0.0, - "precision": 0.0, - "recall": 0.0, - "truePositiveCount": 0, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 1 - } - }, - "microF1": 0.8923077, - "microPrecision": 0.8969072, - "microRecall": 0.8877551, - "macroF1": 0.7766601, - "macroPrecision": 0.7755879, - "macroRecall": 0.78849214 - }, - "intentsEvaluation": { - "confusionMatrix": { - "AddFlag": { - "AddFlag": { - "normalizedValue": 100.0, - "rawValue": 6.0 - } - }, - "AddMore": { - "AddMore": { - "normalizedValue": 100.0, - "rawValue": 17.0 - } - }, - "Cancel": { - "Cancel": { - "normalizedValue": 100.0, - "rawValue": 9.0 - } - }, - "CheckMessages": { - "CheckMessages": { - "normalizedValue": 100.0, - "rawValue": 9.0 - } - }, - "Confirm": { - "Confirm": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "Delete": { - "Delete": { - "normalizedValue": 100.0, - "rawValue": 5.0 - } - }, - "Forward": { - "Forward": { - "normalizedValue": 100.0, - "rawValue": 6.0 - } - }, - "None": { - "None": { - "normalizedValue": 100.0, - "rawValue": 1.0 - } - }, - "QueryLastText": { - "QueryLastText": { - "normalizedValue": 100.0, - "rawValue": 6.0 - } - }, - "ReadAloud": { - "ReadAloud": { - "normalizedValue": 100.0, - "rawValue": 16.0 - } - }, - "Reply": { - "Reply": { - "normalizedValue": 100.0, - "rawValue": 6.0 - } - }, - "SearchMessages": { - "SearchMessages": { - "normalizedValue": 100.0, - "rawValue": 9.0 - } - }, - "SendEmail": { - "SendEmail": { - "normalizedValue": 100.0, - "rawValue": 20.0 - } - }, - "ShowNext": { - "ShowNext": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "ShowPrevious": { - "ShowPrevious": { - "normalizedValue": 100.0, - "rawValue": 3.0 - } - } - }, - "intents": { - "AddMore": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 17, - "trueNegativeCount": 104, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Cancel": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 9, - "trueNegativeCount": 112, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "SendEmail": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 20, - "trueNegativeCount": 101, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "CheckMessages": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 9, - "trueNegativeCount": 112, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "AddFlag": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 6, - "trueNegativeCount": 115, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Reply": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 6, - "trueNegativeCount": 115, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "ReadAloud": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 16, - "trueNegativeCount": 105, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "QueryLastText": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 6, - "trueNegativeCount": 115, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "SearchMessages": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 9, - "trueNegativeCount": 112, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Delete": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 5, - "trueNegativeCount": 116, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Forward": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 6, - "trueNegativeCount": 115, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Confirm": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 117, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "ShowNext": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 117, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "ShowPrevious": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 3, - "trueNegativeCount": 118, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "None": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 1, - "trueNegativeCount": 120, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - } - }, - "microF1": 1.0, - "microPrecision": 1.0, - "microRecall": 1.0, - "macroF1": 1.0, - "macroPrecision": 1.0, - "macroRecall": 1.0 - }, - "evaluationOptions": { - "kind": "percentage", - "trainingSplitPercentage": 80, - "testingSplitPercentage": 20 - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json deleted file mode 100644 index 0e955806aee2..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "myproject" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "Conversation", - "projectName": "myproject", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json deleted file mode 100644 index 2e9d7115df63..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000", - "createdDateTime": "2022-04-18T14:02:34Z", - "lastUpdatedDateTime": "2022-04-18T14:02:34Z", - "expirationDateTime": "2022-04-25T14:02:34Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json deleted file mode 100644 index 3229d8bc1f9a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json +++ /dev/null @@ -1,398 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectKind": "Conversation" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "languageName": "English", - "languageCode": "en" - }, - { - "languageName": "English", - "languageCode": "en-us" - }, - { - "languageName": "English (UK)", - "languageCode": "en-gb" - }, - { - "languageName": "French", - "languageCode": "fr" - }, - { - "languageName": "Italian", - "languageCode": "it" - }, - { - "languageName": "Spanish", - "languageCode": "es" - }, - { - "languageName": "German", - "languageCode": "de" - }, - { - "languageName": "Portuguese (Brazil)", - "languageCode": "pt-br" - }, - { - "languageName": "Portuguese (Portugal)", - "languageCode": "pt-pt" - }, - { - "languageName": "Chinese (Simplified)", - "languageCode": "zh-hans" - }, - { - "languageName": "Japanese", - "languageCode": "ja" - }, - { - "languageName": "Korean", - "languageCode": "ko" - }, - { - "languageName": "Dutch", - "languageCode": "nl" - }, - { - "languageName": "Hindi", - "languageCode": "hi" - }, - { - "languageName": "Turkish", - "languageCode": "tr" - }, - { - "languageName": "Gujarati", - "languageCode": "gu" - }, - { - "languageName": "Marathi", - "languageCode": "mr" - }, - { - "languageName": "Tamil", - "languageCode": "ta" - }, - { - "languageName": "Telugu", - "languageCode": "te" - }, - { - "languageName": "Zulu", - "languageCode": "zu" - }, - { - "languageName": "Afrikaans", - "languageCode": "af" - }, - { - "languageName": "Amharic", - "languageCode": "am" - }, - { - "languageName": "Arabic", - "languageCode": "ar" - }, - { - "languageName": "Assamese", - "languageCode": "as" - }, - { - "languageName": "Azerbaijani", - "languageCode": "az" - }, - { - "languageName": "Belarusian", - "languageCode": "be" - }, - { - "languageName": "Bulgarian", - "languageCode": "bg" - }, - { - "languageName": "Breton", - "languageCode": "br" - }, - { - "languageName": "Bosnian", - "languageCode": "bs" - }, - { - "languageName": "Catalan", - "languageCode": "ca" - }, - { - "languageName": "Czech", - "languageCode": "cs" - }, - { - "languageName": "Welsh", - "languageCode": "cy" - }, - { - "languageName": "Danish", - "languageCode": "da" - }, - { - "languageName": "Greek", - "languageCode": "el" - }, - { - "languageName": "Esperanto", - "languageCode": "eo" - }, - { - "languageName": "Estonian", - "languageCode": "et" - }, - { - "languageName": "Basque", - "languageCode": "eu" - }, - { - "languageName": "Persian", - "languageCode": "fa" - }, - { - "languageName": "Finnish", - "languageCode": "fi" - }, - { - "languageName": "Western Frisian", - "languageCode": "fy" - }, - { - "languageName": "Irish", - "languageCode": "ga" - }, - { - "languageName": "Scottish Gaelic", - "languageCode": "gd" - }, - { - "languageName": "Galician", - "languageCode": "gl" - }, - { - "languageName": "Hausa", - "languageCode": "ha" - }, - { - "languageName": "Hebrew", - "languageCode": "he" - }, - { - "languageName": "Croatian", - "languageCode": "hr" - }, - { - "languageName": "Hungarian", - "languageCode": "hu" - }, - { - "languageName": "Armenian", - "languageCode": "hy" - }, - { - "languageName": "Indonesian", - "languageCode": "id" - }, - { - "languageName": "Javanese", - "languageCode": "jv" - }, - { - "languageName": "Georgian", - "languageCode": "ka" - }, - { - "languageName": "Kazakh", - "languageCode": "kk" - }, - { - "languageName": "Khmer", - "languageCode": "km" - }, - { - "languageName": "Kannada", - "languageCode": "kn" - }, - { - "languageName": "Kurdish (Kurmanji)", - "languageCode": "ku" - }, - { - "languageName": "Kyrgyz", - "languageCode": "ky" - }, - { - "languageName": "Latin", - "languageCode": "la" - }, - { - "languageName": "Lao", - "languageCode": "lo" - }, - { - "languageName": "Lithuanian", - "languageCode": "lt" - }, - { - "languageName": "Latvian", - "languageCode": "lv" - }, - { - "languageName": "Malagasy", - "languageCode": "mg" - }, - { - "languageName": "Macedonian", - "languageCode": "mk" - }, - { - "languageName": "Malayalam", - "languageCode": "ml" - }, - { - "languageName": "Mongolian", - "languageCode": "mn" - }, - { - "languageName": "Malay", - "languageCode": "ms" - }, - { - "languageName": "Burmese", - "languageCode": "my" - }, - { - "languageName": "Nepali", - "languageCode": "ne" - }, - { - "languageName": "Norwegian (Bokmal)", - "languageCode": "nb" - }, - { - "languageName": "Odia", - "languageCode": "or" - }, - { - "languageName": "Punjabi", - "languageCode": "pa" - }, - { - "languageName": "Polish", - "languageCode": "pl" - }, - { - "languageName": "Pashto", - "languageCode": "ps" - }, - { - "languageName": "Romanian", - "languageCode": "ro" - }, - { - "languageName": "Russian", - "languageCode": "ru" - }, - { - "languageName": "Sanskrit", - "languageCode": "sa" - }, - { - "languageName": "Sindhi", - "languageCode": "sd" - }, - { - "languageName": "Sinhala", - "languageCode": "si" - }, - { - "languageName": "Slovak", - "languageCode": "sk" - }, - { - "languageName": "Slovenian", - "languageCode": "sl" - }, - { - "languageName": "Somali", - "languageCode": "so" - }, - { - "languageName": "Albanian", - "languageCode": "sq" - }, - { - "languageName": "Serbian", - "languageCode": "sr" - }, - { - "languageName": "Sundanese", - "languageCode": "su" - }, - { - "languageName": "Swedish", - "languageCode": "sv" - }, - { - "languageName": "Swahili", - "languageCode": "sw" - }, - { - "languageName": "Thai", - "languageCode": "th" - }, - { - "languageName": "Filipino", - "languageCode": "tl" - }, - { - "languageName": "Uyghur", - "languageCode": "ug" - }, - { - "languageName": "Ukrainian", - "languageCode": "uk" - }, - { - "languageName": "Urdu", - "languageCode": "ur" - }, - { - "languageName": "Uzbek", - "languageCode": "uz" - }, - { - "languageName": "Vietnamese", - "languageCode": "vi" - }, - { - "languageName": "Xhosa", - "languageCode": "xh" - }, - { - "languageName": "Yiddish", - "languageCode": "yi" - }, - { - "languageName": "Chinese (Traditional)", - "languageCode": "zh-hant" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json deleted file mode 100644 index a680f2a670da..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json +++ /dev/null @@ -1,98 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "language": "en" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "category": "Person.Name", - "description": "Name of an individual", - "examples": "john, Sam, Lisa" - }, - { - "category": "General.Event", - "description": "Important events", - "examples": "World War two, Covid 19" - }, - { - "category": "General.Organization", - "description": "Companies and corporations", - "examples": "Microsoft, Amazon" - }, - { - "category": "Choice.Boolean", - "description": "boolean choice", - "examples": "yes, no, agreed" - }, - { - "category": "Quantity.Age", - "description": "Age of a person or thing", - "examples": "10-month-old, 19 years old, 58 year-old" - }, - { - "category": "Quantity.NumberRange", - "description": "a numeric interval", - "examples": "between 25 and 35, 25-35" - }, - { - "category": "Quantity.Number", - "description": "A cardinal number in numeric or text form", - "examples": "ten, forty two, 3.141, 10K" - }, - { - "category": "Quantity.Percentage", - "description": "A percentage, using the symbol % or the word \"percent\"", - "examples": "10%, 5.6 percent" - }, - { - "category": "Quantity.Ordinal", - "description": "An ordinal number in numeric or text form", - "examples": "first, second, tenth, 1st, 2nd, 10th" - }, - { - "category": "Quantity.Dimension", - "description": "Spacial dimensions, including length, distance, area, and volume", - "examples": "2 miles, 650 square kilometres, 9,350 feet" - }, - { - "category": "Quantity.Temperature", - "description": "A temperature in celsius or fahrenheit", - "examples": "32F, 34 degrees celsius, 2 deg C" - }, - { - "category": "Quantity.Currency", - "description": "Monetary amounts, including currency", - "examples": "1000.00 US dollars, £20.00, $ 67.5 B" - }, - { - "category": "DateTime", - "description": "exact date values", - "examples": "May 11th" - }, - { - "category": "Email", - "description": "Email addresses", - "examples": "user@example.net, user_name@example.com, user.Name12@example.net" - }, - { - "category": "Phone Number", - "description": "US phone numbers", - "examples": "123-456-7890, +1 123 456 789, (123)456-789" - }, - { - "category": "URL", - "description": "Websites URLs and links", - "examples": "www.example.com, http://example.net?name=my_name&age=10" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json deleted file mode 100644 index 80b178609bfe..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectKind": "Conversation" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "trainingConfigVersion": "2022-05-01", - "modelExpirationDate": "2022-10-28" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json deleted file mode 100644 index 6b56378c4ff4..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", - "createdDateTime": "2022-04-18T16:09:50Z", - "lastUpdatedDateTime": "2022-04-18T16:09:58Z", - "expirationDateTime": "2022-04-25T16:09:50Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json deleted file mode 100644 index 0bd15d2ed2f6..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "result": { - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "trainingMode": "standard", - "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", - "trainingStatus": { - "percentComplete": 3, - "startDateTime": "2022-04-18T15:45:06.8190649Z", - "status": "running" - }, - "evaluationStatus": { - "percentComplete": 0, - "status": "notStarted" - } - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:45:48Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "running" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json deleted file mode 100644 index 92883355a4be..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json deleted file mode 100644 index ec32cfb9dab5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json +++ /dev/null @@ -1,78 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "body": { - "projectFileVersion": "2022-05-01", - "stringIndexType": "Utf16CodeUnit", - "metadata": { - "projectKind": "Conversation", - "settings": { - "confidenceThreshold": 0.7 - }, - "projectName": "EmailApp", - "multilingual": true, - "description": "Trying out CLU", - "language": "en-us" - }, - "assets": { - "projectKind": "Conversation", - "intents": [ - { - "category": "Read" - }, - { - "category": "Delete" - } - ], - "entities": [ - { - "category": "Sender" - }, - { - "category": "Number", - "regex": { - "expressions": [ - { - "regexKey": "UK Phone numbers", - "language": "en-us", - "regexPattern": "/^\\(?([0-9]{3})\\)?[-.\\s]?([0-9]{3})[-.\\s]?([0-9]{4})$/" - } - ] - } - } - ], - "utterances": [ - { - "text": "Open Blake's email", - "dataset": "Train", - "intent": "Read", - "entities": [ - { - "category": "Sender", - "offset": 5, - "length": 5 - } - ] - }, - { - "text": "Delete last email", - "language": "en-gb", - "dataset": "Test", - "intent": "Delete", - "entities": [] - } - ] - } - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json deleted file mode 100644 index 4a8e6268f30e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "projectName": "Booking", - "deploymentsMetadata": [ - { - "deploymentName": "staging", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "deploymentExpirationDate": "2023-10-28" - } - ] - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json deleted file mode 100644 index 3787b4b1d608..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "region": "westeurope" - }, - { - "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", - "region": "eastus" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json deleted file mode 100644 index a413f74934e7..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "deploymentName": "production", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T16:03:51Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01", - "assignedResources": [ - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "region": "westeurope" - }, - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", - "region": "eastus" - } - ] - }, - { - "deploymentName": "staging", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T15:53:04Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json deleted file mode 100644 index 01186dbfb5f8..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "label": "model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49Z", - "lastTrainingDurationInSeconds": 186, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01" - }, - { - "label": "model2", - "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", - "lastTrainedDateTime": "2022-04-18T17:25:22Z", - "lastTrainingDurationInSeconds": 192, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json deleted file mode 100644 index 35833b162649..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "createdDateTime": "2022-04-18T14:03:16Z", - "lastModifiedDateTime": "2022-04-18T14:03:16Z", - "projectKind": "Conversation", - "projectName": "myproject1", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - }, - { - "createdDateTime": "2022-04-18T14:03:12Z", - "lastModifiedDateTime": "2022-04-18T14:03:12Z", - "projectKind": "Conversation", - "projectName": "myproject", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json deleted file mode 100644 index a176f7ee89ac..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json +++ /dev/null @@ -1,90 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "result": { - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "trainingMode": "advanced", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T15:45:06.8190649Z", - "endDateTime": "2022-04-18T15:47:19.2639682Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T15:47:19.2734976Z", - "endDateTime": "2022-04-18T15:47:23.8378892Z", - "status": "succeeded" - } - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:47:50Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "succeeded" - }, - { - "result": { - "modelLabel": "model2", - "trainingConfigVersion": "2022-05-01", - "trainingMode": "standard", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:22:39.3663023Z", - "endDateTime": "2022-04-18T17:24:51.9440947Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:24:51.9571747Z", - "endDateTime": "2022-04-18T17:24:58.1427823Z", - "status": "succeeded" - } - }, - "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", - "createdDateTime": "2022-04-18T17:22:11Z", - "lastUpdatedDateTime": "2022-04-18T17:25:23Z", - "expirationDateTime": "2022-04-25T17:22:11Z", - "status": "succeeded" - }, - { - "result": { - "modelLabel": "model2", - "trainingConfigVersion": "2022-05-01", - "trainingMode": "standard", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:44:41.388358Z", - "endDateTime": "2022-04-18T17:50:29.5675101Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:50:29.5808461Z", - "endDateTime": "2022-04-18T17:50:35.3482185Z", - "status": "succeeded" - } - }, - "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", - "createdDateTime": "2022-04-18T17:44:04Z", - "lastUpdatedDateTime": "2022-04-18T17:51:11Z", - "expirationDateTime": "2022-04-25T17:44:04Z", - "status": "succeeded" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json deleted file mode 100644 index 7f429ba55567..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/load-snapshot/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json deleted file mode 100644 index a6033ed77afa..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "body": { - "firstDeploymentName": "production", - "secondDeploymentName": "staging" - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json deleted file mode 100644 index 3fb14f0272d7..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "body": { - "modelLabel": "model1", - "trainingMode": "standard", - "trainingConfigVersion": "latest", - "evaluationOptions": { - "kind": "percentage", - "testingSplitPercentage": 20, - "trainingSplitPercentage": 80 - } - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json deleted file mode 100644 index 8145a493290f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "EmailApp", - "deploymentName": "production", - "body": { - "assignedResourceIds": [ - "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" - ] - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/resources/unassign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulAssignDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulAssignDeploymentResources.json deleted file mode 100644 index dbe79ce12f64..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulAssignDeploymentResources.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "body": { - "resourcesMetadata": [ - { - "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "customDomain": "lang-test-weu.cognitiveservices.azure.com", - "region": "westeurope" - }, - { - "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", - "customDomain": "lang-test-eus.cognitiveservices.azure.com", - "region": "eastus" - } - ] - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/resources/assign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json deleted file mode 100644 index 4e924d988e71..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulCreateProject.json deleted file mode 100644 index fd5b5e8d3285..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulCreateProject.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/merge-patch+json", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "body": { - "projectName": "LoanAgreements", - "language": "en", - "projectKind": "CustomEntityRecognition", - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "multilingual": false, - "storageInputContainerName": "loanagreements" - } - }, - "responses": { - "201": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - } - }, - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json deleted file mode 100644 index e962ef9ee5d1..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "deploymentName": "staging" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/staging/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulDeleteDeploymentFromResources.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulDeleteDeploymentFromResources.json deleted file mode 100644 index 7074f2050d93..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulDeleteDeploymentFromResources.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "deploymentName": "staging", - "body": { - "assignedResourceIds": [ - "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" - ] - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/deployments/staging/delete-from-resources/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulDeleteModel.json deleted file mode 100644 index 5d3c61dbfd5a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulDeleteModel.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model2" - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulDeleteProject.json deleted file mode 100644 index eaa6872c1f80..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulDeleteProject.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulDeployProject.json deleted file mode 100644 index 6654a9d7310d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulDeployProject.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "deploymentName": "production", - "body": { - "trainedModelLabel": "29886710a2ae49259d62cffca977db66", - "assignedResourceIds": [ - "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus" - ] - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulExportProject.json deleted file mode 100644 index 05770fb05a2d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulExportProject.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "stringIndexType": "Utf16CodeUnit" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json deleted file mode 100644 index 015471529f73..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetDeleteDeploymentFromResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetDeleteDeploymentFromResourcesStatus.json deleted file mode 100644 index dfaf3ad973cc..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetDeleteDeploymentFromResourcesStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "deploymentName": "production", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetDeployment.json deleted file mode 100644 index a0c84aa79c0d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetDeployment.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "deploymentName": "staging" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "deploymentName": "staging", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T15:53:04Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-15-preview", - "assignedResources": [ - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "region": "westeurope" - }, - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", - "region": "eastus" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json deleted file mode 100644 index dfaf3ad973cc..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "deploymentName": "production", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetExportStatus.json deleted file mode 100644 index 2e40afdc9781..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetExportStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "resultUrl": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2022-10-01-preview", - "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", - "createdDateTime": "2022-04-18T15:23:07Z", - "lastUpdatedDateTime": "2022-04-18T15:23:08Z", - "expirationDateTime": "2022-04-25T15:23:07Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetImportStatus.json deleted file mode 100644 index 413f0142aba9..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetImportStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", - "createdDateTime": "2022-04-18T15:17:20Z", - "lastUpdatedDateTime": "2022-04-18T15:17:22Z", - "expirationDateTime": "2022-04-25T15:17:20Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetLoadSnapshotStatus.json deleted file mode 100644 index e28687b9a3dd..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetLoadSnapshotStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model1", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:45:48Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "running" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetModel.json deleted file mode 100644 index fe3b7b1abac6..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetModel.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "label": "model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49Z", - "lastTrainingDurationInSeconds": 186, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json deleted file mode 100644 index c55f45ccd7b9..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json +++ /dev/null @@ -1,295 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model2", - "stringIndexType": "Utf16CodeUnit", - "maxpagesize": 10 - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "location": "11.txt", - "language": "en-us", - "projectKind": "CustomEntityRecognition", - "customEntityRecognitionResult": { - "entities": [ - { - "expectedEntities": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "BorrowerName", - "offset": 160, - "length": 13 - }, - { - "category": "BorrowerAddress", - "offset": 181, - "length": 34 - }, - { - "category": "BorrowerCity", - "offset": 225, - "length": 6 - }, - { - "category": "BorrowerState", - "offset": 242, - "length": 8 - }, - { - "category": "LenderName", - "offset": 271, - "length": 12 - }, - { - "category": "LenderAddress", - "offset": 310, - "length": 20 - }, - { - "category": "LenderCity", - "offset": 340, - "length": 8 - }, - { - "category": "LenderState", - "offset": 359, - "length": 11 - }, - { - "category": "LoanAmountWords", - "offset": 448, - "length": 52 - }, - { - "category": "LoanAmountNumbers", - "offset": 502, - "length": 10 - }, - { - "category": "Interest", - "offset": 588, - "length": 2 - } - ], - "predictedEntities": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "BorrowerName", - "offset": 160, - "length": 13 - }, - { - "category": "BorrowerAddress", - "offset": 200, - "length": 15 - }, - { - "category": "BorrowerCity", - "offset": 225, - "length": 6 - }, - { - "category": "BorrowerState", - "offset": 242, - "length": 8 - }, - { - "category": "LenderName", - "offset": 271, - "length": 12 - }, - { - "category": "LenderAddress", - "offset": 310, - "length": 20 - }, - { - "category": "LenderCity", - "offset": 340, - "length": 8 - }, - { - "category": "LenderState", - "offset": 359, - "length": 11 - }, - { - "category": "LoanAmountWords", - "offset": 448, - "length": 52 - }, - { - "category": "LoanAmountNumbers", - "offset": 502, - "length": 10 - }, - { - "category": "Interest", - "offset": 588, - "length": 2 - } - ], - "regionOffset": 0, - "regionLength": 1780 - } - ] - } - }, - { - "location": "01.txt", - "language": "en-us", - "projectKind": "CustomEntityRecognition", - "customEntityRecognitionResult": { - "entities": [ - { - "expectedEntities": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "BorrowerName", - "offset": 160, - "length": 13 - }, - { - "category": "BorrowerAddress", - "offset": 200, - "length": 13 - }, - { - "category": "BorrowerCity", - "offset": 223, - "length": 9 - }, - { - "category": "BorrowerState", - "offset": 243, - "length": 8 - }, - { - "category": "LenderName", - "offset": 273, - "length": 14 - }, - { - "category": "LenderAddress", - "offset": 314, - "length": 15 - }, - { - "category": "LenderCity", - "offset": 339, - "length": 10 - }, - { - "category": "LenderState", - "offset": 360, - "length": 8 - }, - { - "category": "LoanAmountWords", - "offset": 446, - "length": 66 - }, - { - "category": "LoanAmountNumbers", - "offset": 514, - "length": 11 - }, - { - "category": "Interest", - "offset": 601, - "length": 2 - } - ], - "predictedEntities": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "BorrowerName", - "offset": 160, - "length": 13 - }, - { - "category": "BorrowerAddress", - "offset": 200, - "length": 13 - }, - { - "category": "BorrowerCity", - "offset": 223, - "length": 9 - }, - { - "category": "BorrowerState", - "offset": 243, - "length": 8 - }, - { - "category": "LenderName", - "offset": 273, - "length": 14 - }, - { - "category": "LenderAddress", - "offset": 314, - "length": 15 - }, - { - "category": "LenderCity", - "offset": 339, - "length": 10 - }, - { - "category": "LenderState", - "offset": 360, - "length": 8 - }, - { - "category": "LoanAmountWords", - "offset": 446, - "length": 66 - }, - { - "category": "LoanAmountNumbers", - "offset": 514, - "length": 11 - }, - { - "category": "Interest", - "offset": 601, - "length": 2 - } - ], - "regionOffset": 0, - "regionLength": 1793 - } - ] - } - } - ], - "nextLink": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/models/model2/evaluation/result/?api-version=2022-10-01-preview&top=2147483645&skip={maxpagesize}&maxpagesize={maxpagesize}" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json deleted file mode 100644 index daf5a27ba5ef..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json +++ /dev/null @@ -1,232 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model2" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "projectKind": "CustomEntityRecognition", - "customEntityRecognitionEvaluation": { - "confusionMatrix": { - "BorrowerAddress": { - "BorrowerAddress": { - "normalizedValue": 86.206894, - "rawValue": 3.4482758 - }, - "$none": { - "normalizedValue": 13.793103, - "rawValue": 0.55172414 - } - }, - "BorrowerCity": { - "BorrowerCity": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "BorrowerName": { - "BorrowerName": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "BorrowerState": { - "BorrowerState": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "Date": { - "Date": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "Interest": { - "Interest": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LenderAddress": { - "LenderAddress": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LenderCity": { - "LenderCity": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LenderName": { - "LenderName": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LenderState": { - "LenderState": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LoanAmountNumbers": { - "LoanAmountNumbers": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LoanAmountWords": { - "LoanAmountWords": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "$none": { - "$none": { - "normalizedValue": 99.81485, - "rawValue": 51.90372 - }, - "BorrowerAddress": { - "normalizedValue": 0.18315019, - "rawValue": 0.0952381 - }, - "Interest": { - "normalizedValue": 0.002005294, - "rawValue": 0.0010427529 - } - } - }, - "entities": { - "Date": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "BorrowerName": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "BorrowerAddress": { - "f1": 0.6666666865348816, - "precision": 0.6000000238418579, - "recall": 0.75, - "truePositiveCount": 3, - "trueNegativeCount": 0, - "falsePositiveCount": 2, - "falseNegativeCount": 1 - }, - "BorrowerCity": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "BorrowerState": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LenderName": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LenderAddress": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LenderCity": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LenderState": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LoanAmountWords": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LoanAmountNumbers": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Interest": { - "f1": 0.75, - "precision": 0.75, - "recall": 0.75, - "truePositiveCount": 3, - "trueNegativeCount": 0, - "falsePositiveCount": 1, - "falseNegativeCount": 1 - } - }, - "microF1": 0.94845366, - "microPrecision": 0.93877554, - "microRecall": 0.9583333, - "macroF1": 0.9513889, - "macroPrecision": 0.9458334, - "macroRecall": 0.9583333 - }, - "evaluationOptions": { - "kind": "percentage", - "trainingSplitPercentage": 80, - "testingSplitPercentage": 20 - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetProject.json deleted file mode 100644 index a448aba898b8..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetProject.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json deleted file mode 100644 index 2e9d7115df63..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000", - "createdDateTime": "2022-04-18T14:02:34Z", - "lastUpdatedDateTime": "2022-04-18T14:02:34Z", - "expirationDateTime": "2022-04-25T14:02:34Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json deleted file mode 100644 index 0afb9e6fa0f1..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json +++ /dev/null @@ -1,389 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "languageName": "English", - "languageCode": "en" - }, - { - "languageName": "English", - "languageCode": "en-us" - }, - { - "languageName": "French", - "languageCode": "fr" - }, - { - "languageName": "Italian", - "languageCode": "it" - }, - { - "languageName": "Spanish", - "languageCode": "es" - }, - { - "languageName": "German", - "languageCode": "de" - }, - { - "languageName": "Portuguese (Brazil)", - "languageCode": "pt-br" - }, - { - "languageName": "Portuguese (Portugal)", - "languageCode": "pt-pt" - }, - { - "languageName": "Afrikaans", - "languageCode": "af" - }, - { - "languageName": "Amharic", - "languageCode": "am" - }, - { - "languageName": "Arabic", - "languageCode": "ar" - }, - { - "languageName": "Assamese", - "languageCode": "as" - }, - { - "languageName": "Azerbaijani", - "languageCode": "az" - }, - { - "languageName": "Belarusian", - "languageCode": "be" - }, - { - "languageName": "Bulgarian", - "languageCode": "bg" - }, - { - "languageName": "Breton", - "languageCode": "br" - }, - { - "languageName": "Bosnian", - "languageCode": "bs" - }, - { - "languageName": "Catalan", - "languageCode": "ca" - }, - { - "languageName": "Czech", - "languageCode": "cs" - }, - { - "languageName": "Welsh", - "languageCode": "cy" - }, - { - "languageName": "Danish", - "languageCode": "da" - }, - { - "languageName": "Greek", - "languageCode": "el" - }, - { - "languageName": "Esperanto", - "languageCode": "eo" - }, - { - "languageName": "Estonian", - "languageCode": "et" - }, - { - "languageName": "Basque", - "languageCode": "eu" - }, - { - "languageName": "Persian", - "languageCode": "fa" - }, - { - "languageName": "Finnish", - "languageCode": "fi" - }, - { - "languageName": "Western Frisian", - "languageCode": "fy" - }, - { - "languageName": "Irish", - "languageCode": "ga" - }, - { - "languageName": "Scottish Gaelic", - "languageCode": "gd" - }, - { - "languageName": "Galician", - "languageCode": "gl" - }, - { - "languageName": "Gujarati", - "languageCode": "gu" - }, - { - "languageName": "Hausa", - "languageCode": "ha" - }, - { - "languageName": "Hebrew", - "languageCode": "he" - }, - { - "languageName": "Hindi", - "languageCode": "hi" - }, - { - "languageName": "Croatian", - "languageCode": "hr" - }, - { - "languageName": "Hungarian", - "languageCode": "hu" - }, - { - "languageName": "Armenian", - "languageCode": "hy" - }, - { - "languageName": "Indonesian", - "languageCode": "id" - }, - { - "languageName": "Japanese", - "languageCode": "ja" - }, - { - "languageName": "Javanese", - "languageCode": "jv" - }, - { - "languageName": "Georgian", - "languageCode": "ka" - }, - { - "languageName": "Kazakh", - "languageCode": "kk" - }, - { - "languageName": "Khmer", - "languageCode": "km" - }, - { - "languageName": "Kannada", - "languageCode": "kn" - }, - { - "languageName": "Korean", - "languageCode": "ko" - }, - { - "languageName": "Kurdish (Kurmanji)", - "languageCode": "ku" - }, - { - "languageName": "Kyrgyz", - "languageCode": "ky" - }, - { - "languageName": "Latin", - "languageCode": "la" - }, - { - "languageName": "Lao", - "languageCode": "lo" - }, - { - "languageName": "Lithuanian", - "languageCode": "lt" - }, - { - "languageName": "Latvian", - "languageCode": "lv" - }, - { - "languageName": "Malagasy", - "languageCode": "mg" - }, - { - "languageName": "Macedonian", - "languageCode": "mk" - }, - { - "languageName": "Malayalam", - "languageCode": "ml" - }, - { - "languageName": "Mongolian", - "languageCode": "mn" - }, - { - "languageName": "Marathi", - "languageCode": "mr" - }, - { - "languageName": "Malay", - "languageCode": "ms" - }, - { - "languageName": "Burmese", - "languageCode": "my" - }, - { - "languageName": "Nepali", - "languageCode": "ne" - }, - { - "languageName": "Dutch", - "languageCode": "nl" - }, - { - "languageName": "Norwegian (Bokmal)", - "languageCode": "nb" - }, - { - "languageName": "Odia", - "languageCode": "or" - }, - { - "languageName": "Punjabi", - "languageCode": "pa" - }, - { - "languageName": "Polish", - "languageCode": "pl" - }, - { - "languageName": "Pashto", - "languageCode": "ps" - }, - { - "languageName": "Romanian", - "languageCode": "ro" - }, - { - "languageName": "Russian", - "languageCode": "ru" - }, - { - "languageName": "Sanskrit", - "languageCode": "sa" - }, - { - "languageName": "Sindhi", - "languageCode": "sd" - }, - { - "languageName": "Sinhala", - "languageCode": "si" - }, - { - "languageName": "Slovak", - "languageCode": "sk" - }, - { - "languageName": "Slovenian", - "languageCode": "sl" - }, - { - "languageName": "Somali", - "languageCode": "so" - }, - { - "languageName": "Albanian", - "languageCode": "sq" - }, - { - "languageName": "Serbian", - "languageCode": "sr" - }, - { - "languageName": "Sundanese", - "languageCode": "su" - }, - { - "languageName": "Swedish", - "languageCode": "sv" - }, - { - "languageName": "Swahili", - "languageCode": "sw" - }, - { - "languageName": "Tamil", - "languageCode": "ta" - }, - { - "languageName": "Telugu", - "languageCode": "te" - }, - { - "languageName": "Thai", - "languageCode": "th" - }, - { - "languageName": "Filipino", - "languageCode": "tl" - }, - { - "languageName": "Turkish", - "languageCode": "tr" - }, - { - "languageName": "Uyghur", - "languageCode": "ug" - }, - { - "languageName": "Ukrainian", - "languageCode": "uk" - }, - { - "languageName": "Urdu", - "languageCode": "ur" - }, - { - "languageName": "Uzbek", - "languageCode": "uz" - }, - { - "languageName": "Vietnamese", - "languageCode": "vi" - }, - { - "languageName": "Xhosa", - "languageCode": "xh" - }, - { - "languageName": "Yiddish", - "languageCode": "yi" - }, - { - "languageName": "Chinese (Simplified)", - "languageCode": "zh-hans" - }, - { - "languageName": "Chinese (Traditional)", - "languageCode": "zh-hant" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json deleted file mode 100644 index 2956a3ebd342..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectKind": "CustomEntityRecognition" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "trainingConfigVersion": "2022-05-01", - "modelExpirationDate": "2022-10-28" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json deleted file mode 100644 index a373d78a1fdd..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", - "createdDateTime": "2022-04-18T16:09:50Z", - "lastUpdatedDateTime": "2022-04-18T16:09:58Z", - "expirationDateTime": "2022-04-25T16:09:50Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json deleted file mode 100644 index d68c526b6869..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "result": { - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", - "trainingStatus": { - "percentComplete": 3, - "startDateTime": "2022-04-18T15:45:06.8190649Z", - "status": "running" - }, - "evaluationStatus": { - "percentComplete": 0, - "status": "notStarted" - } - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:45:48Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "running" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json deleted file mode 100644 index 015471529f73..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulImportProject.json deleted file mode 100644 index bfd3315b8f84..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulImportProject.json +++ /dev/null @@ -1,99 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "body": { - "projectFileVersion": "2022-05-01", - "stringIndexType": "Utf16CodeUnit", - "metadata": { - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "settings": {}, - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - }, - "assets": { - "projectKind": "CustomEntityRecognition", - "entities": [ - { - "category": "Date" - }, - { - "category": "LenderName" - }, - { - "category": "LenderAddress" - } - ], - "documents": [ - { - "location": "01.txt", - "language": "en-us", - "entities": [ - { - "regionOffset": 0, - "regionLength": 1793, - "labels": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "LenderName", - "offset": 273, - "length": 14 - }, - { - "category": "LenderAddress", - "offset": 314, - "length": 15 - } - ] - } - ] - }, - { - "location": "02.txt", - "language": "en-us", - "entities": [ - { - "regionOffset": 0, - "regionLength": 1804, - "labels": [ - { - "category": "Date", - "offset": 5, - "length": 10 - }, - { - "category": "LenderName", - "offset": 284, - "length": 10 - }, - { - "category": "LenderAddress", - "offset": 321, - "length": 20 - } - ] - } - ] - } - ] - } - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListAssignedResourceDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListAssignedResourceDeployments.json deleted file mode 100644 index 4a8e6268f30e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListAssignedResourceDeployments.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "projectName": "Booking", - "deploymentsMetadata": [ - { - "deploymentName": "staging", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "deploymentExpirationDate": "2023-10-28" - } - ] - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListDeploymentResources.json deleted file mode 100644 index ec6522114101..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListDeploymentResources.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "region": "westeurope" - }, - { - "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", - "region": "eastus" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListDeployments.json deleted file mode 100644 index 54a27a2d2d81..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListDeployments.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "deploymentName": "production", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T16:03:51Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01", - "assignedResources": [ - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "region": "westeurope" - }, - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", - "region": "eastus" - } - ] - }, - { - "deploymentName": "staging", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T15:53:04Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListModels.json deleted file mode 100644 index 91f22b3b2b6e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListModels.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "label": "model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49Z", - "lastTrainingDurationInSeconds": 186, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01" - }, - { - "label": "model2", - "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", - "lastTrainedDateTime": "2022-04-18T17:25:22Z", - "lastTrainingDurationInSeconds": 192, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListProjects.json deleted file mode 100644 index 7e0ed8e07f5e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListProjects.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - }, - { - "createdDateTime": "2022-04-18T14:03:12Z", - "lastModifiedDateTime": "2022-04-18T14:03:12Z", - "projectKind": "CustomMultiLabelClassification", - "storageInputContainerName": "loanagreements", - "projectName": "MoviesSummary", - "multilingual": false, - "description": "This is a sample dataset adapted from the CMU Movie Summary public dataset. This was prepared by Microsoft Azure Language Services product team to prepare this dataset to be used as a sample for getting started with Custom text classification. This sample dataset consists of 210 files each of them is a movie summary. Each movie can be classified into one or more of the following classes: \"Mystery\", \"Drama\", \"Thriller\", \"Comedy\", \"Action\".", - "language": "en" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json deleted file mode 100644 index 097db8867916..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json +++ /dev/null @@ -1,87 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "result": { - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T15:45:06.8190649Z", - "endDateTime": "2022-04-18T15:47:19.2639682Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T15:47:19.2734976Z", - "endDateTime": "2022-04-18T15:47:23.8378892Z", - "status": "succeeded" - } - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:47:50Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "succeeded" - }, - { - "result": { - "modelLabel": "model2", - "trainingConfigVersion": "2022-05-01", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:22:39.3663023Z", - "endDateTime": "2022-04-18T17:24:51.9440947Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:24:51.9571747Z", - "endDateTime": "2022-04-18T17:24:58.1427823Z", - "status": "succeeded" - } - }, - "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", - "createdDateTime": "2022-04-18T17:22:11Z", - "lastUpdatedDateTime": "2022-04-18T17:25:23Z", - "expirationDateTime": "2022-04-25T17:22:11Z", - "status": "succeeded" - }, - { - "result": { - "modelLabel": "model2", - "trainingConfigVersion": "2022-05-01", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:44:41.388358Z", - "endDateTime": "2022-04-18T17:50:29.5675101Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:50:29.5808461Z", - "endDateTime": "2022-04-18T17:50:35.3482185Z", - "status": "succeeded" - } - }, - "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", - "createdDateTime": "2022-04-18T17:44:04Z", - "lastUpdatedDateTime": "2022-04-18T17:51:11Z", - "expirationDateTime": "2022-04-25T17:44:04Z", - "status": "succeeded" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulLoadSnapshot.json deleted file mode 100644 index b2502b0d0904..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulLoadSnapshot.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model1" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/models/model1/load-snapshot/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulSwapDeployments.json deleted file mode 100644 index 612a247b0b9f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulSwapDeployments.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "body": { - "firstDeploymentName": "production", - "secondDeploymentName": "staging" - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulTrainProject.json deleted file mode 100644 index 90bf0223e53d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulTrainProject.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "body": { - "modelLabel": "model1", - "trainingConfigVersion": "latest", - "evaluationOptions": { - "kind": "percentage", - "testingSplitPercentage": 20, - "trainingSplitPercentage": 80 - } - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulUnassignDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulUnassignDeploymentResources.json deleted file mode 100644 index 733e976d124d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/analyzetext-authoring/SuccessfulUnassignDeploymentResources.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "projectName": "LoanAgreements", - "deploymentName": "production", - "body": { - "assignedResourceIds": [ - "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" - ] - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/resources/unassign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulAnalyzeConversations.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulAnalyzeConversations.json deleted file mode 100644 index d79ed20974d5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulAnalyzeConversations.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "id": "1", - "participantId": "1", - "text": "play In the air tonight from Phil Collins" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "play In the air tonight from Phil Collins", - "prediction": { - "topIntent": "PlayMusic", - "projectKind": "Conversation", - "intents": [ - { - "category": "PlayMusic", - "confidenceScore": 1 - }, - { - "category": "SearchCreativeWork", - "confidenceScore": 0 - }, - { - "category": "AddToPlaylist", - "confidenceScore": 0 - } - ], - "entities": [ - { - "category": "Media.Artist", - "text": "Phil Collins", - "offset": 29, - "length": 12, - "confidenceScore": 1 - } - ] - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json deleted file mode 100644 index b0366e52d17d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "participantId": "1", - "id": "1", - "modality": "text", - "language": "en-GB", - "text": "How do I integrate QnA Maker and LUIS?" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "verbose": true, - "isLoggingEnabled": false, - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Rail", - "projectKind": "Orchestration", - "intents": { - "Rail": { - "confidenceScore": 1, - "targetProjectKind": "Conversation", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Timetable", - "projectKind": "Conversation", - "intents": [ - { - "category": "Timetable", - "confidenceScore": 0.99968535 - }, - { - "category": "Locomotive", - "confidenceScore": 0.000314623 - } - ], - "entities": [] - } - } - }, - "Tree": { - "confidenceScore": 0.2641529, - "targetProjectKind": "QuestionAnswering" - }, - "None": { - "confidenceScore": 0, - "targetProjectKind": "NonLinked" - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json deleted file mode 100644 index 21d046d4c4f3..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "text": "Ports and connectors", - "participantId": "1", - "id": "1" - } - }, - "parameters": { - "projectName": "prj1", - "deploymentName": "dep1", - "directTarget": "qnaProject", - "targetProjectParameters": { - "qnaProject": { - "targetProjectKind": "QuestionAnswering", - "callingOptions": { - "context": { - "previousUserQuery": "Meet Surface Pro 4", - "previousQnaId": 4 - }, - "top": 1, - "question": "App Service overview" - } - } - } - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "Ports and connectors", - "prediction": { - "projectKind": "Orchestration", - "topIntent": "qnaTargetApp", - "intents": { - "qnaTargetApp": { - "targetProjectKind": "QuestionAnswering", - "confidenceScore": 1, - "result": { - "answers": [ - { - "questions": [ - "App Service overview" - ], - "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.", - "confidenceScore": 0.7384000000000001, - "id": 1, - "source": "https://docs.microsoft.com/en-us/azure/app-service/overview", - "metadata": {}, - "dialog": { - "isContextOnly": false, - "prompts": [] - } - } - ] - } - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json deleted file mode 100644 index 8ff38a9deef4..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversations/jobs/{jobId}?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationPIISubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationPIISubmit.json deleted file mode 100644 index 98116451ac5d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationPIISubmit.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "piiCategories": [ - "All" - ], - "redactionSource": "lexical", - "includeAudioRedaction": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationPIITaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationPIITaskStatusRequest.json deleted file mode 100644 index 874deaeb6e33..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationPIITaskStatusRequest.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "ConversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning *************.", - "itn": "good morning *************", - "maskedItn": "good morning *************", - "lexical": "good morning *************", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [ - { - "category": "Name", - "confidenceScore": 0.91, - "length": 8, - "offset": 13, - "text": "john doe" - } - ] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSentimentSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSentimentSubmit.json deleted file mode 100644 index 4ec88af7201f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSentimentSubmit.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Sentiment Analysis from a call center conversation", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "I like the service. I do not like the food", - "lexical": "i like the service i do not like the food", - "itn": "", - "maskedItn": "" - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation Sentiment Analysis", - "kind": "ConversationalSentimentTask", - "parameters": { - "modelVersion": "latest", - "predictionSource": "text" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSentimentTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSentimentTaskStatusRequest.json deleted file mode 100644 index 6c67be4feda3..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSentimentTaskStatusRequest.json +++ /dev/null @@ -1,60 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-01T15:00:45Z", - "displayName": "Sentiment Analysis from a call center conversation", - "expirationDateTime": "2022-04-01T15:00:45Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-04-01T15:00:45Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "ConversationalSentimentResults", - "taskName": "Conversation Sentiment", - "lastUpdateDateTime": "2022-04-01T15:00:45Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "participantId": "agent_1", - "sentiment": "mixed", - "confidenceScores": { - "positive": 0.5, - "neutral": 0.01, - "negative": 0.49 - } - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-10-01-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSummarizationTaskResult.json deleted file mode 100644 index db45b79590e0..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSummarizationTaskResult.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Conversation Summarization Example", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "ConversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "Conversation Summarization Task 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "summaries": [ - { - "aspect": "chapterTitle", - "text": "Bug Triage", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - } - ] - }, - { - "aspect": "narrative", - "text": "Speaker 3 believes there are 3 remaining bugs.", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - }, - { - "conversationItemId": "3", - "offset": 0, - "length": 7 - } - ] - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2022-10-01-preview" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json deleted file mode 100644 index 7e11b3f39553..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Analyze chat", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "ConversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "analyze 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "20220101meeting", - "summaries": [ - { - "aspect": "issue", - "text": "Customer wants to cancel his subscription. Customer doesn't know how" - }, - { - "aspect": "resolution", - "text": "pii Auto-Fortify. \npii Gamertag.\npii E-mail.\nCanceled customer's subscription" - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json deleted file mode 100644 index bf9c24b7f61f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Conversation Summarization Example", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "conversationItems": [ - { - "participantId": "speaker 1", - "id": "1", - "text": "Let's get started.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 0, - "duration": 20000000 - } - }, - { - "participantId": "speaker 2", - "id": "2", - "text": "OK. How many remaining bugs do we have now?", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 20000000, - "duration": 50000000 - } - }, - { - "participantId": "speaker 3", - "id": "3", - "text": "Only 3.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 50000000, - "duration": 60000000 - } - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation Summarization Task 1", - "kind": "ConversationalSummarizationTask", - "parameters": { - "summaryAspects": [ - "chapterTitle", - "narrative" - ] - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSummarySubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSummarySubmit.json deleted file mode 100644 index 1e935c6f63aa..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSummarySubmit.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Analyze conversations from Contoso meeting", - "analysisInput": { - "conversations": [ - { - "id": "20220101meeting", - "language": "en", - "modality": "text", - "domain": "generic", - "conversationItems": [ - { - "participantId": "user", - "role": "customer", - "id": "1", - "text": "Hi!" - }, - { - "participantId": "agent", - "role": "agent", - "id": "2", - "text": "Hello, how can I help you?" - }, - { - "participantId": "user", - "role": "customer", - "id": "3", - "text": "I am having trouble issuing a return of a game on my xbox: call of duty" - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "analyze 1", - "kind": "ConversationalSummarizationTask", - "parameters": { - "modelVersion": "latest", - "summaryAspects": [ - "issue", - "resolution" - ] - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json deleted file mode 100644 index 422faab9e5c8..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json +++ /dev/null @@ -1,99 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1", - "deploymentName": "production", - "knowledgeBaseQueryOptions": { - "question": "how long it takes to charge surface?", - "top": 3, - "userId": "sd53lsY=", - "confidenceScoreThreshold": 0.2, - "context": { - "previousQnaId": 9, - "previousUserQuery": "Where are QnA Maker quickstarts?" - }, - "rankerType": "Default", - "filters": { - "metadataFilter": { - "metadata": [ - { - "key": "category", - "value": "api" - }, - { - "key": "editorial", - "value": "chitchat" - } - ], - "logicalOperation": "AND" - }, - "sourceFilter": [ - "filename1.pdf", - "https://www.wikipedia.org/microsoft" - ], - "logicalOperation": "AND" - }, - "answerSpanRequest": { - "enable": true, - "confidenceScoreThreshold": 0.2, - "topAnswersWithSpan": 1 - }, - "includeUnstructuredSources": true - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "answers": [ - { - "questions": [ - "Power and charging" - ], - "answer": "Power and charging**\n\nIt takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.\n\nYou can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface.", - "confidenceScore": 0.65, - "id": 20, - "source": "surface-pro-4-user-guide-EN.pdf", - "metadata": { - "category": "api", - "editorial": "chitchat" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 23, - "displayText": "prompt1" - }, - { - "displayOrder": 2, - "qnaId": 36, - "displayText": "prompt2" - } - ] - }, - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0.3, - "offset": 33, - "length": 50 - } - }, - { - "questions": [ - "Charge your Surface Pro 4" - ], - "answer": "**Charge your Surface Pro 4**\n\n1. Connect the two parts of the power cord.\n\n2. Connect the power cord securely to the charging port.\n\n3. Plug the power supply into an electrical outlet.", - "confidenceScore": 0.32, - "id": 13, - "source": "surface-pro-4-user-guide-EN.pdf" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/SuccessfulQueryText.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/SuccessfulQueryText.json deleted file mode 100644 index f70df8ede11f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/SuccessfulQueryText.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "stringIndexType": "TextElements_v8", - "textQueryOptions": { - "question": "how long it takes to charge surface?", - "records": [ - { - "id": "1", - "text": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it." - }, - { - "id": "2", - "text": "You can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface." - } - ], - "language": "en" - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "answers": [ - { - "answer": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", - "confidenceScore": 0.93, - "id": "1", - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0, - "offset": 28, - "length": 45 - }, - "offset": 0, - "length": 224 - }, - { - "answer": "It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", - "confidenceScore": 0.92, - "id": "1", - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0, - "offset": 8, - "length": 25 - }, - "offset": 20, - "length": 224 - }, - { - "answer": "It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", - "confidenceScore": 0.05, - "id": "1", - "answerSpan": null, - "offset": 110, - "length": 244 - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json deleted file mode 100644 index 993b478b6bfc..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1", - "body": { - "description": "proj1 is a test project.", - "language": "en", - "settings": { - "defaultAnswer": "No good match found for your question in the Knowledgebase." - }, - "multilingualResource": true - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "settings": { - "defaultAnswer": "No good match found for your question in the Knowledgebase." - }, - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - }, - "201": { - "headers": {}, - "body": { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "settings": { - "defaultAnswer": "No good match found for your question in the Knowledgebase." - }, - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json deleted file mode 100644 index 97de75ad06fd..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1" - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/deletion-jobs/job1?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulGetProject.json deleted file mode 100644 index 4cf55a2a8328..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulGetProject.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "settings": { - "defaultAnswer": "No good match found for your question in the Knowledgebase." - }, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json deleted file mode 100644 index c748a5b3d148..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": 1, - "answer": "ans1", - "source": "source1", - "questions": [ - "question 1.1", - "question 1.2" - ], - "metadata": { - "k1": "v1", - "k2": "v2" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 11, - "displayText": "prompt 1.1" - }, - { - "displayOrder": 2, - "qnaId": 21, - "displayText": "prompt 1.2" - } - ] - }, - "lastUpdatedDateTime": "2021-05-01T17:21:14Z" - }, - { - "id": 2, - "answer": "ans2", - "source": "source2", - "questions": [ - "question 2.1", - "question 2.2" - ], - "lastUpdatedDateTime": "2021-05-01T17:21:14Z" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulGetSources.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulGetSources.json deleted file mode 100644 index f2963bb28371..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulGetSources.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "displayName": "source1", - "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview", - "sourceKind": "url", - "lastUpdatedDateTime": "2021-05-01T15:13:22Z", - "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview" - }, - { - "displayName": "source2", - "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf", - "sourceKind": "file", - "contentStructureKind": "unstructured", - "lastUpdatedDateTime": "2021-05-01T15:13:22Z", - "source": "surface-guide.pdf" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json deleted file mode 100644 index c64f2d49ceb2..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "alterations": [ - "qnamaker", - "qna maker" - ] - }, - { - "alterations": [ - "botframework", - "bot framework" - ] - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json deleted file mode 100644 index b1e2ba94a0f7..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json deleted file mode 100644 index 1bd2502da684..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1", - "deploymentName": "production", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json deleted file mode 100644 index c7ad0d4b6096..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded", - "resultUrl": "https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json deleted file mode 100644 index 630a38ae5134..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json deleted file mode 100644 index adfa402a0c45..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "deploymentName": "production", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json deleted file mode 100644 index 1607a97124f3..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1", - "deploymentName": "production" - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/deployments/production/jobs/job1?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json deleted file mode 100644 index e5ef14b8b096..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1", - "body": { - "exportAssetTypes": [ - "qnas", - "synonyms" - ] - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded", - "resultUrl": "https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2022-10-01-preview" - } - }, - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json deleted file mode 100644 index f78fb528afed..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json +++ /dev/null @@ -1,73 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1", - "body": { - "assets": { - "synonyms": [ - { - "alterations": [ - "wa", - "washington", - "washington state" - ] - }, - { - "alterations": [ - "U.S", - "usa", - "united states of america" - ] - } - ], - "qnas": [ - { - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "id": 1, - "answer": "ans1", - "source": "source1", - "questions": [ - "question 1.1", - "question 1.2" - ], - "metadata": { - "k1": "v1", - "k2": "v2" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 2, - "displayText": "prompt 1.1" - } - ] - } - }, - { - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "id": 2, - "answer": "ans2", - "source": "source2", - "questions": [ - "question 2.1", - "question 2.2" - ] - } - ] - } - } - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/import/jobs/job1?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json deleted file mode 100644 index 84a8adc26c75..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - }, - { - "projectName": "proj2", - "description": "proj2 is a test project.", - "language": "fr", - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json deleted file mode 100644 index 00aaf9634730..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1", - "body": { - "records": [ - { - "userId": "user1", - "userQuestion": "hi", - "qnaId": 1 - }, - { - "userId": "user1", - "userQuestion": "hello", - "qnaId": 2 - } - ] - } - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json deleted file mode 100644 index 5d4b7a11cb51..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1", - "body": [ - { - "op": "add", - "value": { - "id": 3, - "answer": "ans3", - "source": "source1", - "questions": [ - "question 3.1", - "question 3.2" - ], - "metadata": { - "k1": "v1", - "k2": "v2" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 11, - "displayText": "prompt 3.1" - }, - { - "displayOrder": 2, - "qnaId": 21, - "displayText": "prompt 3.2" - } - ] - } - } - }, - { - "op": "replace", - "value": { - "id": 1, - "answer": "ans4", - "source": "source1", - "questions": [ - "question 4.1", - "question 4.2" - ] - } - }, - { - "op": "delete", - "value": { - "id": 2, - "answer": "ans2", - "source": "source1", - "questions": [ - "question 2.1", - "question 2.2" - ] - } - } - ] - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/qnas/jobs/job1?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json deleted file mode 100644 index 630a38ae5134..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json deleted file mode 100644 index dcf2c9b75b14..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1", - "body": [ - { - "op": "add", - "value": { - "displayName": "source3", - "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context", - "sourceKind": "url", - "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context" - } - }, - { - "op": "replace", - "value": { - "displayName": "source1", - "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview", - "sourceKind": "url", - "refresh": true, - "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview" - } - }, - { - "op": "delete", - "value": { - "displayName": "source2", - "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf", - "sourceKind": "file", - "source": "surface-guide.pdf" - } - } - ] - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/sources/jobs/job1?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json deleted file mode 100644 index 630a38ae5134..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json deleted file mode 100644 index 29076fe18b51..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2022-10-01-preview", - "projectName": "proj1", - "body": { - "value": [ - { - "alterations": [ - "qnamaker", - "qna maker" - ] - }, - { - "alterations": [ - "botframework", - "bot framework" - ] - } - ] - } - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulAbstractiveSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulAbstractiveSummarizationTaskResult.json deleted file mode 100644 index 5f49d06449ab..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulAbstractiveSummarizationTaskResult.json +++ /dev/null @@ -1,56 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Document Abstractive Summarization Task Example", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "AbstractiveSummarizationLROResults", - "taskName": "Document Abstractive Summarization Task 1", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "summaries": [ - { - "text": "Microsoft have been on a quest to advance AI beyond existing techniques.", - "contexts": [ - { - "offset": 0, - "length": 1629 - } - ] - } - ], - "id": "1", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2022-10-01-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.json deleted file mode 100644 index c6e5283ed892..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Document Abstractive Summarization Task Example", - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks." - } - ] - }, - "tasks": [ - { - "kind": "AbstractiveSummarization", - "taskName": "Document Abstractive Summarization Task 1", - "parameters": { - "sentenceCount": 1 - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulAnalyzeTextJobsCancelRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulAnalyzeTextJobsCancelRequest.json deleted file mode 100644 index 2ace80dd02a4..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulAnalyzeTextJobsCancelRequest.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json deleted file mode 100644 index 3e466bafb69c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json +++ /dev/null @@ -1,131 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Extracting Location & US Region", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 2, - "failed": 0, - "inProgress": 0, - "total": 2, - "items": [ - { - "kind": "EntityRecognitionLROResults", - "taskName": "Recognize Entities", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "entities": [ - { - "category": "Event", - "confidenceScore": 0.61, - "length": 4, - "offset": 18, - "text": "trip" - }, - { - "category": "Location", - "confidenceScore": 0.82, - "length": 7, - "offset": 26, - "subcategory": "GPE", - "text": "Seattle" - }, - { - "category": "DateTime", - "confidenceScore": 0.8, - "length": 9, - "offset": 34, - "subcategory": "DateRange", - "text": "last week" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "Location", - "confidenceScore": 0.52, - "length": 3, - "offset": 14, - "subcategory": "GPE", - "text": "NYC" - }, - { - "category": "DateTime", - "confidenceScore": 0.8, - "length": 8, - "offset": 18, - "subcategory": "Date", - "text": "tomorrow" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-04-01" - } - }, - { - "kind": "CustomEntityRecognitionLROResults", - "taskName": "Recognize US Regions", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "entities": [ - { - "category": "USRegion", - "confidenceScore": 0.85, - "length": 17, - "offset": 45, - "text": "Pacific Northwest" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "USRegion", - "confidenceScore": 0.88, - "length": 10, - "offset": 63, - "text": "East Coast" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "projectName": "MyProject", - "deploymentName": "MyDeployment" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json deleted file mode 100644 index 032208017fe7..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Extracting Location & US Region", - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "I had a wonderful trip to Seattle last week." - }, - { - "id": "2", - "language": "en", - "text": "I'm flying to NYC tomorrow. See you there." - } - ] - }, - "tasks": [ - { - "kind": "EntityRecognition", - "taskName": "Recognize Entities", - "parameters": { - "modelVersion": "latest" - } - }, - { - "kind": "CustomEntityRecognition", - "taskName": "Recognize US Regions", - "parameters": { - "projectName": "MyProject", - "deploymentName": "MyDeployment" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulEntityLinkingRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulEntityLinkingRequest.json deleted file mode 100644 index 5f35d957d126..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulEntityLinkingRequest.json +++ /dev/null @@ -1,128 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "EntityLinking", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Microsoft was founded by Bill Gates and Paul Allen." - }, - { - "id": "2", - "language": "en", - "text": "Pike place market is my favorite Seattle attraction." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "EntityLinkingResults", - "results": { - "documents": [ - { - "entities": [ - { - "dataSource": "Wikipedia", - "id": "Bill Gates", - "language": "en", - "matches": [ - { - "confidenceScore": 0.52, - "length": 10, - "offset": 25, - "text": "Bill Gates" - } - ], - "name": "Bill Gates", - "url": "https://en.wikipedia.org/wiki/Bill_Gates" - }, - { - "dataSource": "Wikipedia", - "id": "Paul Allen", - "language": "en", - "matches": [ - { - "confidenceScore": 0.54, - "length": 10, - "offset": 40, - "text": "Paul Allen" - } - ], - "name": "Paul Allen", - "url": "https://en.wikipedia.org/wiki/Paul_Allen" - }, - { - "dataSource": "Wikipedia", - "id": "Microsoft", - "language": "en", - "matches": [ - { - "confidenceScore": 0.49, - "length": 9, - "offset": 0, - "text": "Microsoft" - } - ], - "name": "Microsoft", - "url": "https://en.wikipedia.org/wiki/Microsoft" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "dataSource": "Wikipedia", - "id": "Pike Place Market", - "language": "en", - "matches": [ - { - "confidenceScore": 0.86, - "length": 17, - "offset": 0, - "text": "Pike place market" - } - ], - "name": "Pike Place Market", - "url": "https://en.wikipedia.org/wiki/Pike_Place_Market" - }, - { - "dataSource": "Wikipedia", - "id": "Seattle", - "language": "en", - "matches": [ - { - "confidenceScore": 0.27, - "length": 7, - "offset": 33, - "text": "Seattle" - } - ], - "name": "Seattle", - "url": "https://en.wikipedia.org/wiki/Seattle" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-02-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulEntityRecognitionRequest.json deleted file mode 100644 index 0e8f012315c9..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulEntityRecognitionRequest.json +++ /dev/null @@ -1,98 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "EntityRecognition", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975." - }, - { - "id": "2", - "language": "en", - "text": "Pike place market is my favorite Seattle attraction." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "EntityRecognitionResults", - "results": { - "documents": [ - { - "entities": [ - { - "category": "Organization", - "confidenceScore": 0.84, - "length": 9, - "offset": 0, - "text": "Microsoft" - }, - { - "category": "Person", - "confidenceScore": 0.85, - "length": 10, - "offset": 25, - "text": "Bill Gates" - }, - { - "category": "Person", - "confidenceScore": 0.9, - "length": 10, - "offset": 40, - "text": "Paul Allen" - }, - { - "text": "April 4, 1975", - "category": "DateTime", - "subcategory": "Date", - "offset": 54, - "length": 13, - "confidenceScore": 0.99, - "resolutions": [ - { - "resolutionKind": "DateTimeResolution", - "dateTimeSubKind": "Date", - "timex": "1975-04-04", - "value": "1975-04-04" - } - ] - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "Location", - "confidenceScore": 0.55, - "length": 7, - "offset": 33, - "subcategory": "GPE", - "text": "Seattle" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-06-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulHealthcareDocumentTypePostRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulHealthcareDocumentTypePostRequest.json deleted file mode 100644 index 71253d13a0af..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulHealthcareDocumentTypePostRequest.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "analysisInput": { - "documents": [ - { - "text": "Prescribed 100mg ibuprofen, taken twice daily.", - "id": "1", - "language": "en" - } - ] - }, - "tasks": [ - { - "kind": "Healthcare", - "parameters": { - "modelVersion": "latest", - "fhirVersion": "4.0.1", - "documentType": "DischargeSummary" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json deleted file mode 100644 index addffd05af3a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json +++ /dev/null @@ -1,552 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "15e4a46b-62e2-4386-8d36-9c2a92bb45dd" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-09-06T23:47:43Z", - "displayName": "Providing Document Type", - "expirationDateTime": "2022-09-07T23:47:43Z", - "jobId": "15e4a46b-62e2-4386-8d36-9c2a92bb45dd", - "lastUpdatedDateTime": "2022-09-06T23:48:10Z", - "status": "succeeded", - "errors": [], - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "HealthcareLROResults", - "lastUpdateDateTime": "2022-09-06T23:48:10.1762027Z", - "status": "succeeded", - "results": { - "documents": [ - { - "id": "a", - "entities": [ - { - "offset": 11, - "length": 5, - "text": "100mg", - "category": "Dosage", - "confidenceScore": 0.98 - }, - { - "offset": 17, - "length": 9, - "text": "ibuprofen", - "category": "MedicationName", - "confidenceScore": 1.0, - "name": "ibuprofen", - "links": [ - { - "dataSource": "UMLS", - "id": "C0020740" - }, - { - "dataSource": "AOD", - "id": "0000019879" - }, - { - "dataSource": "ATC", - "id": "M01AE01" - }, - { - "dataSource": "CCPSS", - "id": "0046165" - }, - { - "dataSource": "CHV", - "id": "0000006519" - }, - { - "dataSource": "CSP", - "id": "2270-2077" - }, - { - "dataSource": "DRUGBANK", - "id": "DB01050" - }, - { - "dataSource": "GS", - "id": "1611" - }, - { - "dataSource": "LCH_NW", - "id": "sh97005926" - }, - { - "dataSource": "LNC", - "id": "LP16165-0" - }, - { - "dataSource": "MEDCIN", - "id": "40458" - }, - { - "dataSource": "MMSL", - "id": "d00015" - }, - { - "dataSource": "MSH", - "id": "D007052" - }, - { - "dataSource": "MTHSPL", - "id": "WK2XYI10QM" - }, - { - "dataSource": "NCI", - "id": "C561" - }, - { - "dataSource": "NCI_CTRP", - "id": "C561" - }, - { - "dataSource": "NCI_DCP", - "id": "00803" - }, - { - "dataSource": "NCI_DTP", - "id": "NSC0256857" - }, - { - "dataSource": "NCI_FDA", - "id": "WK2XYI10QM" - }, - { - "dataSource": "NCI_NCI-GLOSS", - "id": "CDR0000613511" - }, - { - "dataSource": "NDDF", - "id": "002377" - }, - { - "dataSource": "PDQ", - "id": "CDR0000040475" - }, - { - "dataSource": "RCD", - "id": "x02MO" - }, - { - "dataSource": "RXNORM", - "id": "5640" - }, - { - "dataSource": "SNM", - "id": "E-7772" - }, - { - "dataSource": "SNMI", - "id": "C-603C0" - }, - { - "dataSource": "SNOMEDCT_US", - "id": "387207008" - }, - { - "dataSource": "USP", - "id": "m39860" - }, - { - "dataSource": "USPMG", - "id": "MTHU000060" - }, - { - "dataSource": "VANDF", - "id": "4017840" - } - ] - }, - { - "offset": 34, - "length": 11, - "text": "twice daily", - "category": "Frequency", - "confidenceScore": 1.0 - } - ], - "relations": [ - { - "confidenceScore": 1.0, - "relationType": "DosageOfMedication", - "entities": [ - { - "ref": "#/results/documents/0/entities/0", - "role": "Dosage" - }, - { - "ref": "#/results/documents/0/entities/1", - "role": "Medication" - } - ] - }, - { - "confidenceScore": 1.0, - "relationType": "FrequencyOfMedication", - "entities": [ - { - "ref": "#/results/documents/0/entities/1", - "role": "Medication" - }, - { - "ref": "#/results/documents/0/entities/2", - "role": "Frequency" - } - ] - } - ], - "warnings": [], - "fhirBundle": { - "resourceType": "Bundle", - "id": "6ee4a7c0-5911-4c4b-bea2-3c2a1fe5c65f", - "meta": { - "profile": [ - "http://hl7.org/fhir/4.0.1/StructureDefinition/Bundle" - ] - }, - "identifier": { - "system": "urn:ietf:rfc:3986", - "value": "urn:uuid:6ee4a7c0-5911-4c4b-bea2-3c2a1fe5c65f" - }, - "type": "document", - "entry": [ - { - "fullUrl": "Composition/5bd33290-b92e-4aa5-becf-535578207946", - "resource": { - "resourceType": "Composition", - "id": "5bd33290-b92e-4aa5-becf-535578207946", - "status": "final", - "type": { - "coding": [ - { - "system": "http://loinc.org", - "code": "18842-5", - "display": "Discharge summary" - } - ], - "text": "Discharge summary" - }, - "subject": { - "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", - "type": "Patient" - }, - "encounter": { - "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", - "type": "Encounter", - "display": "unknown" - }, - "date": "2022-09-06", - "author": [ - { - "reference": "Practitioner/bba2dee3-2eb3-4973-b4b9-62d498b17046", - "type": "Practitioner", - "display": "Unknown" - } - ], - "title": "Discharge summary", - "section": [ - { - "title": "General", - "code": { - "coding": [ - { - "system": "", - "display": "Unrecognized Section" - } - ], - "text": "General" - }, - "text": { - "status": "additional", - "div": "
\r\n\t\t\t\t\t\t\t

General

\r\n\t\t\t\t\t\t\t

Prescribed 100mg ibuprofen, taken twice daily.

\r\n\t\t\t\t\t
" - }, - "entry": [ - { - "reference": "List/6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", - "type": "List", - "display": "General" - } - ] - } - ] - } - }, - { - "fullUrl": "Practitioner/bba2dee3-2eb3-4973-b4b9-62d498b17046", - "resource": { - "resourceType": "Practitioner", - "id": "bba2dee3-2eb3-4973-b4b9-62d498b17046", - "name": [ - { - "text": "Unknown", - "family": "Unknown" - } - ] - } - }, - { - "fullUrl": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", - "resource": { - "resourceType": "Patient", - "id": "efcccdf7-87f0-4061-b553-09fc11734594", - "gender": "unknown" - } - }, - { - "fullUrl": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", - "resource": { - "resourceType": "Encounter", - "id": "76214457-f94c-4ccf-95ef-ab31e7232d63", - "meta": { - "profile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter" - ] - }, - "status": "finished", - "class": { - "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", - "display": "unknown" - }, - "subject": { - "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", - "type": "Patient" - }, - "period": { - "start": "2022-09-06", - "end": "2022-09-06" - } - } - }, - { - "fullUrl": "MedicationStatement/ac0264b6-63b7-4cf2-a7c3-f7340788aca7", - "resource": { - "resourceType": "MedicationStatement", - "id": "ac0264b6-63b7-4cf2-a7c3-f7340788aca7", - "extension": [ - { - "extension": [ - { - "url": "offset", - "valueInteger": 17 - }, - { - "url": "length", - "valueInteger": 9 - } - ], - "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" - } - ], - "status": "active", - "medicationCodeableConcept": { - "coding": [ - { - "system": "http://www.nlm.nih.gov/research/umls", - "code": "C0020740", - "display": "ibuprofen" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/aod", - "code": "0000019879" - }, - { - "system": "http://www.whocc.no/atc", - "code": "M01AE01" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/ccpss", - "code": "0046165" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/chv", - "code": "0000006519" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/csp", - "code": "2270-2077" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/drugbank", - "code": "DB01050" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/gs", - "code": "1611" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/lch_nw", - "code": "sh97005926" - }, - { - "system": "http://loinc.org", - "code": "LP16165-0" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/medcin", - "code": "40458" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/mmsl", - "code": "d00015" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/msh", - "code": "D007052" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/mthspl", - "code": "WK2XYI10QM" - }, - { - "system": "http://ncimeta.nci.nih.gov", - "code": "C561" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", - "code": "C561" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/nci_dcp", - "code": "00803" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", - "code": "NSC0256857" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/nci_fda", - "code": "WK2XYI10QM" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", - "code": "CDR0000613511" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/nddf", - "code": "002377" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/pdq", - "code": "CDR0000040475" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/rcd", - "code": "x02MO" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/rxnorm", - "code": "5640" - }, - { - "system": "http://snomed.info/sct", - "code": "E-7772" - }, - { - "system": "http://snomed.info/sct", - "code": "C-603C0" - }, - { - "system": "http://snomed.info/sct", - "code": "387207008" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/usp", - "code": "m39860" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/uspmg", - "code": "MTHU000060" - }, - { - "system": "http://hl7.org/fhir/ndfrt", - "code": "4017840" - } - ], - "text": "ibuprofen" - }, - "subject": { - "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", - "type": "Patient" - }, - "context": { - "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", - "type": "Encounter", - "display": "unknown" - }, - "dosage": [ - { - "text": "100mg", - "timing": { - "repeat": { - "frequency": 2, - "period": 1, - "periodUnit": "d" - }, - "code": { - "text": "twice daily" - } - }, - "doseAndRate": [ - { - "doseQuantity": { - "value": 100 - } - } - ] - } - ] - } - }, - { - "fullUrl": "List/6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", - "resource": { - "resourceType": "List", - "id": "6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", - "status": "current", - "mode": "snapshot", - "title": "General", - "subject": { - "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", - "type": "Patient" - }, - "encounter": { - "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", - "type": "Encounter", - "display": "unknown" - }, - "entry": [ - { - "item": { - "reference": "MedicationStatement/ac0264b6-63b7-4cf2-a7c3-f7340788aca7", - "type": "MedicationStatement", - "display": "ibuprofen" - } - } - ] - } - } - ] - } - } - ], - "errors": [], - "modelVersion": "2022-03-01" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulHealthcarePostRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulHealthcarePostRequest.json deleted file mode 100644 index efa7ae44949d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulHealthcarePostRequest.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "analysisInput": { - "documents": [ - { - "text": "Prescribed 100mg ibuprofen, taken twice daily.", - "id": "1", - "language": "en" - } - ] - }, - "tasks": [ - { - "kind": "Healthcare", - "parameters": { - "modelVersion": "latest" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2022-10-01-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulHealthcareTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulHealthcareTaskStatusRequest.json deleted file mode 100644 index 2e7c456a31d0..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulHealthcareTaskStatusRequest.json +++ /dev/null @@ -1,220 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-07-20T18:43:35Z", - "displayName": "Extracting Location & US Region", - "expirationDateTime": "2022-07-21T18:43:35Z", - "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0", - "lastUpdatedDateTime": "2022-07-20T18:43:36Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "HealthcareLROResults", - "lastUpdateDateTime": "2022-07-20T18:43:36.7159045Z", - "status": "succeeded", - "results": { - "documents": [ - { - "id": "1", - "entities": [ - { - "offset": 11, - "length": 5, - "text": "100mg", - "category": "Dosage", - "confidenceScore": 0.98 - }, - { - "offset": 17, - "length": 9, - "text": "ibuprofen", - "category": "MedicationName", - "confidenceScore": 1, - "name": "ibuprofen", - "links": [ - { - "dataSource": "UMLS", - "id": "C0020740" - }, - { - "dataSource": "AOD", - "id": "0000019879" - }, - { - "dataSource": "ATC", - "id": "M01AE01" - }, - { - "dataSource": "CCPSS", - "id": "0046165" - }, - { - "dataSource": "CHV", - "id": "0000006519" - }, - { - "dataSource": "CSP", - "id": "2270-2077" - }, - { - "dataSource": "DRUGBANK", - "id": "DB01050" - }, - { - "dataSource": "GS", - "id": "1611" - }, - { - "dataSource": "LCH_NW", - "id": "sh97005926" - }, - { - "dataSource": "LNC", - "id": "LP16165-0" - }, - { - "dataSource": "MEDCIN", - "id": "40458" - }, - { - "dataSource": "MMSL", - "id": "d00015" - }, - { - "dataSource": "MSH", - "id": "D007052" - }, - { - "dataSource": "MTHSPL", - "id": "WK2XYI10QM" - }, - { - "dataSource": "NCI", - "id": "C561" - }, - { - "dataSource": "NCI_CTRP", - "id": "C561" - }, - { - "dataSource": "NCI_DCP", - "id": "00803" - }, - { - "dataSource": "NCI_DTP", - "id": "NSC0256857" - }, - { - "dataSource": "NCI_FDA", - "id": "WK2XYI10QM" - }, - { - "dataSource": "NCI_NCI-GLOSS", - "id": "CDR0000613511" - }, - { - "dataSource": "NDDF", - "id": "002377" - }, - { - "dataSource": "PDQ", - "id": "CDR0000040475" - }, - { - "dataSource": "RCD", - "id": "x02MO" - }, - { - "dataSource": "RXNORM", - "id": "5640" - }, - { - "dataSource": "SNM", - "id": "E-7772" - }, - { - "dataSource": "SNMI", - "id": "C-603C0" - }, - { - "dataSource": "SNOMEDCT_US", - "id": "387207008" - }, - { - "dataSource": "USP", - "id": "m39860" - }, - { - "dataSource": "USPMG", - "id": "MTHU000060" - }, - { - "dataSource": "VANDF", - "id": "4017840" - } - ] - }, - { - "offset": 34, - "length": 11, - "text": "twice daily", - "category": "Frequency", - "confidenceScore": 1 - } - ], - "relations": [ - { - "confidenceScore": 1, - "relationType": "DosageOfMedication", - "entities": [ - { - "ref": "#/results/documents/0/entities/0", - "role": "Dosage" - }, - { - "ref": "#/results/documents/0/entities/1", - "role": "Medication" - } - ] - }, - { - "confidenceScore": 1, - "relationType": "FrequencyOfMedication", - "entities": [ - { - "ref": "#/results/documents/0/entities/1", - "role": "Medication" - }, - { - "ref": "#/results/documents/0/entities/2", - "role": "Frequency" - } - ] - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2022-03-01" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulKeyPhraseExtractionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulKeyPhraseExtractionRequest.json deleted file mode 100644 index bd33e0464c42..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulKeyPhraseExtractionRequest.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "KeyPhraseExtraction", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Microsoft was founded by Bill Gates and Paul Allen." - }, - { - "id": "2", - "language": "en", - "text": "Text Analytics is one of the Azure Cognitive Services." - }, - { - "id": "3", - "language": "en", - "text": "My cat might need to see a veterinarian." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "KeyPhraseExtractionResults", - "results": { - "documents": [ - { - "id": "1", - "keyPhrases": [ - "Bill Gates", - "Paul Allen", - "Microsoft" - ], - "warnings": [] - }, - { - "id": "2", - "keyPhrases": [ - "Azure Cognitive Services", - "Text Analytics" - ], - "warnings": [] - }, - { - "id": "3", - "keyPhrases": [ - "cat", - "veterinarian" - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-06-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulLanguageDetectionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulLanguageDetectionRequest.json deleted file mode 100644 index 70f9c979f41c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulLanguageDetectionRequest.json +++ /dev/null @@ -1,84 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "LanguageDetection", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "text": "Hello world" - }, - { - "id": "2", - "text": "Bonjour tout le monde" - }, - { - "id": "3", - "text": "Hola mundo" - }, - { - "id": "4", - "text": "Tumhara naam kya hai?" - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "LanguageDetectionResults", - "results": { - "documents": [ - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "en", - "name": "English" - }, - "id": "1", - "warnings": [] - }, - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "fr", - "name": "French" - }, - "id": "2", - "warnings": [] - }, - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "es", - "name": "Spanish" - }, - "id": "3", - "warnings": [] - }, - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "hi", - "name": "Hindi", - "script": "Latin" - }, - "id": "4", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-01-05" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulPiiEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulPiiEntityRecognitionRequest.json deleted file mode 100644 index 369d0e8c70a8..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulPiiEntityRecognitionRequest.json +++ /dev/null @@ -1,88 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "PiiEntityRecognition", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "My SSN is 859-98-0987" - }, - { - "id": "2", - "language": "en", - "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." - }, - { - "id": "3", - "language": "en", - "text": "Is 998.214.865-68 your Brazilian CPF number?" - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "PiiEntityRecognitionResults", - "results": { - "documents": [ - { - "id": "1", - "redactedText": "My SSN is ***********", - "entities": [ - { - "category": "U.S. Social Security Number (SSN)", - "confidenceScore": 0.65, - "length": 11, - "offset": 28, - "text": "859-98-0987" - } - ], - "warnings": [] - }, - { - "id": "2", - "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", - "entities": [ - { - "category": "ABA Routing Number", - "confidenceScore": 0.75, - "length": 9, - "offset": 18, - "text": "111000025" - } - ], - "warnings": [] - }, - { - "id": "3", - "redactedText": "Is ************** your Brazilian CPF number?", - "entities": [ - { - "category": "Brazil CPF Number", - "confidenceScore": 0.85, - "length": 14, - "offset": 3, - "text": "998.214.865-68" - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-01-15" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulSentimentAnalysisRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulSentimentAnalysisRequest.json deleted file mode 100644 index 5b7642037ba9..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfulSentimentAnalysisRequest.json +++ /dev/null @@ -1,148 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-10-01-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "SentimentAnalysis", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "SentimentAnalysisResults", - "results": { - "documents": [ - { - "confidenceScores": { - "negative": 0, - "neutral": 0, - "positive": 1 - }, - "id": "1", - "sentences": [ - { - "targets": [ - { - "confidenceScores": { - "negative": 0, - "positive": 1 - }, - "length": 10, - "offset": 6, - "relations": [ - { - "ref": "#/documents/0/sentences/0/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "atmosphere" - } - ], - "confidenceScores": { - "negative": 0, - "neutral": 0, - "positive": 1 - }, - "length": 17, - "offset": 0, - "assessments": [ - { - "confidenceScores": { - "negative": 0, - "positive": 1 - }, - "isNegated": false, - "length": 5, - "offset": 0, - "sentiment": "positive", - "text": "great" - } - ], - "sentiment": "positive", - "text": "Great atmosphere." - }, - { - "targets": [ - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "length": 11, - "offset": 37, - "relations": [ - { - "ref": "#/documents/0/sentences/1/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "restaurants" - }, - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "length": 6, - "offset": 50, - "relations": [ - { - "ref": "#/documents/0/sentences/1/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "hotels" - } - ], - "confidenceScores": { - "negative": 0.01, - "neutral": 0.86, - "positive": 0.13 - }, - "length": 52, - "offset": 18, - "assessments": [ - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "isNegated": false, - "length": 15, - "offset": 18, - "sentiment": "positive", - "text": "Close to plenty" - } - ], - "sentiment": "neutral", - "text": "Close to plenty of restaurants, hotels, and transit!" - } - ], - "sentiment": "positive", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-10-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/questionanswering-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/questionanswering-authoring.json deleted file mode 100644 index b5b647515286..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/questionanswering-authoring.json +++ /dev/null @@ -1,1804 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Question Answering - Authoring", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2022-10-01-preview" - }, - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" - } - }, - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://cognitiveservices.azure.com/.default" - ] - }, - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language/authoring", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/query-knowledgebases/projects": { - "get": { - "summary": "Gets all projects for a user.", - "operationId": "QuestionAnsweringProjects_ListProjects", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "The metadata of all projects.", - "schema": { - "$ref": "#/definitions/ProjectsMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectsListProjects.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}": { - "get": { - "summary": "Get the requested project metadata.", - "operationId": "QuestionAnsweringProjects_GetProjectDetails", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The metadata for the specified project.", - "schema": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetProject.json" - } - } - }, - "patch": { - "summary": "Create or update a project.", - "operationId": "QuestionAnsweringProjects_CreateProject", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "description": "Parameters needed to create the project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CreateProjectOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The metadata of the updated project, if it already exists.", - "schema": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "201": { - "description": "The metadata of the created project, if it doesn't exist.", - "schema": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulCreateProject.json" - } - } - }, - "delete": { - "summary": "Delete the project.", - "operationId": "QuestionAnsweringProjects_DeleteProject", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulDeleteProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/deletion-jobs/{jobId}": { - "get": { - "summary": "Gets the status of a Project delete job.", - "operationId": "QuestionAnsweringProjects_GetDeleteStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Project delete job status.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/:export": { - "post": { - "summary": "Export project metadata and assets.", - "operationId": "QuestionAnsweringProjects_Export", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ImportExportFormatParameter" - }, - { - "$ref": "#/parameters/AssetKindParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Export job status, project metadata, and assets.", - "schema": { - "$ref": "#/definitions/ExportJobState" - } - }, - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/export/jobs/{jobId}": { - "get": { - "summary": "Gets the status of an Export job, once job completes, returns the project metadata, and assets.", - "operationId": "QuestionAnsweringProjects_GetExportStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Export job status, project metadata, and assets.", - "schema": { - "$ref": "#/definitions/ExportJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/:import": { - "post": { - "summary": "Import project assets.", - "operationId": "QuestionAnsweringProjects_Import", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Project assets the needs to be imported.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/ImportJobOptions" - } - }, - { - "$ref": "#/parameters/ImportExportFormatParameter" - }, - { - "$ref": "#/parameters/AssetKindParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/import/jobs/{jobId}": { - "get": { - "summary": "Gets the status of an Import job.", - "operationId": "QuestionAnsweringProjects_GetImportStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Import job status.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}": { - "put": { - "summary": "Deploy project to production.", - "operationId": "QuestionAnsweringProjects_DeployProject", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { - "get": { - "summary": "Gets the status of a Deploy job.", - "operationId": "QuestionAnsweringProjects_GetDeployStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Deploy job state.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/deployments": { - "get": { - "summary": "List all deployments of a project.", - "operationId": "QuestionAnsweringProjects_ListDeployments", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "List of deployments of a project.", - "schema": { - "$ref": "#/definitions/ProjectDeployments" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectListDeployments.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/synonyms": { - "get": { - "summary": "Gets all the synonyms of a project.", - "operationId": "QuestionAnsweringProjects_GetSynonyms", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "All the synonyms of a project.", - "schema": { - "$ref": "#/definitions/SynonymAssets" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetSynonyms.json" - } - } - }, - "put": { - "summary": "Updates all the synonyms of a project.", - "operationId": "QuestionAnsweringProjects_UpdateSynonyms", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "All the synonyms of a project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SynonymAssets" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "204": { - "description": "Synonyms update successfully." - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/sources": { - "get": { - "summary": "Gets all the sources of a project.", - "operationId": "QuestionAnsweringProjects_GetSources", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "All the sources of a project.", - "schema": { - "$ref": "#/definitions/QnaSources" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetSources.json" - } - } - }, - "patch": { - "summary": "Updates the sources of a project.", - "operationId": "QuestionAnsweringProjects_UpdateSources", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Update sources parameters of a project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateSourcesOptions" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSources.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/sources/jobs/{jobId}": { - "get": { - "summary": "Gets the status of update sources job.", - "operationId": "QuestionAnsweringProjects_GetUpdateSourcesStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Update sources job state.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/qnas": { - "get": { - "summary": "Gets all the QnAs of a project.", - "operationId": "QuestionAnsweringProjects_GetQnas", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SourceFilterParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "All the QnAs of a project.", - "schema": { - "$ref": "#/definitions/QnaAssets" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetQnas.json" - } - } - }, - "patch": { - "summary": "Updates the QnAs of a project.", - "operationId": "QuestionAnsweringProjects_UpdateQnas", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Update QnAs parameters of a project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateQnaOptions" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateQnas.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/query-knowledgebases/projects/{projectName}/qnas/jobs/{jobId}": { - "get": { - "summary": "Gets the status of update QnAs job.", - "operationId": "QuestionAnsweringProjects_GetUpdateQnasStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Update QnAs job state.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json" - } - } - } - }, - "/query-knowledgebases/projects/{projectName}/feedback": { - "post": { - "summary": "Update Active Learning feedback.", - "operationId": "QuestionAnsweringProjects_AddFeedback", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Feedback for Active Learning.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ActiveLearningFeedback" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "204": { - "description": "Feedback recorded successfully." - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json" - } - } - } - } - }, - "definitions": { - "ActiveLearningFeedback": { - "type": "object", - "description": "Feedback for Active Learning.", - "additionalProperties": false, - "properties": { - "records": { - "$ref": "#/definitions/FeedbackRecords" - } - } - }, - "FeedbackRecords": { - "type": "array", - "description": "A list of Feedback Records for Active Learning.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/FeedbackRecord" - } - }, - "FeedbackRecord": { - "type": "object", - "description": "Feedback Record for Active Learning.", - "additionalProperties": false, - "properties": { - "userId": { - "type": "string", - "description": "Unique identifier of the user." - }, - "userQuestion": { - "type": "string", - "description": "User suggested question for the QnA." - }, - "qnaId": { - "type": "integer", - "description": "Unique ID of the QnA.", - "format": "int32" - } - } - }, - "ProjectsMetadata": { - "type": "object", - "description": "Collection of projects metadata and global settings.", - "additionalProperties": false, - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "nextLink": { - "type": "string" - } - } - }, - "ProjectMetadata": { - "type": "object", - "description": "Represents the project.", - "additionalProperties": false, - "properties": { - "projectName": { - "type": "string", - "description": "Name of the project." - }, - "description": { - "type": "string", - "description": "Description of the project." - }, - "language": { - "$ref": "common.json#/definitions/Language" - }, - "multilingualResource": { - "type": "boolean", - "description": "Resource enabled for multiple languages across projects or not." - }, - "settings": { - "$ref": "#/definitions/ProjectSettings" - }, - "createdDateTime": { - "type": "string", - "description": "Project creation date-time.", - "format": "date-time" - }, - "lastModifiedDateTime": { - "type": "string", - "description": "Represents the project last modified date-time.", - "format": "date-time" - }, - "lastDeployedDateTime": { - "type": "string", - "description": "Represents the project last deployment date-time.", - "format": "date-time" - } - } - }, - "CreateProjectOptions": { - "type": "object", - "description": "Parameters needed to create the project.", - "additionalProperties": false, - "required": [ - "language" - ], - "properties": { - "description": { - "type": "string", - "description": "Description of the project." - }, - "language": { - "$ref": "common.json#/definitions/Language" - }, - "multilingualResource": { - "type": "boolean", - "description": "Set to true to enable creating knowledgebases in different languages for the same resource." - }, - "settings": { - "$ref": "#/definitions/ProjectSettings" - } - } - }, - "ProjectSettings": { - "type": "object", - "description": "Configurable settings of the Project.", - "additionalProperties": false, - "properties": { - "defaultAnswer": { - "type": "string", - "description": "Default Answer response when no good match is found in the knowledge base." - } - } - }, - "ImportJobOptions": { - "type": "object", - "description": "Project assets the needs to be imported.", - "additionalProperties": false, - "properties": { - "metadata": { - "$ref": "#/definitions/CreateProjectOptions" - }, - "assets": { - "$ref": "#/definitions/Assets" - }, - "fileUri": { - "type": "string", - "description": "Import data File URI." - } - } - }, - "JobMetadata": { - "description": "Represents the job metadata.", - "properties": { - "createdDateTime": { - "format": "date-time", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "type": "string" - }, - "jobId": { - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { - "$ref": "#/definitions/JobStatus" - } - }, - "required": [ - "jobId", - "lastUpdatedDateTime", - "createdDateTime", - "status" - ], - "type": "object" - }, - "JobStatus": { - "description": "Job Status.", - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling", - "partiallyCompleted" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "jobStatus" - } - }, - "JobState": { - "description": "Job state represents the job metadata and any errors.", - "allOf": [ - { - "$ref": "#/definitions/JobMetadata" - }, - { - "$ref": "#/definitions/Errors" - } - ] - }, - "Errors": { - "description": "Collection of Error types.", - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - } - } - }, - "ExportJobState": { - "description": "Export job status, project metadata, and assets.", - "allOf": [ - { - "$ref": "#/definitions/JobState" - }, - { - "$ref": "#/definitions/ExportJobResultUrl" - } - ] - }, - "ExportJobResultUrl": { - "type": "object", - "description": "URL to download the result of the Export Job.", - "required": [ - "resultUrl" - ], - "properties": { - "resultUrl": { - "type": "string", - "description": "URL to download the result of the Export Job." - } - } - }, - "Assets": { - "type": "object", - "description": "All assets for this project.", - "additionalProperties": false, - "properties": { - "synonyms": { - "$ref": "#/definitions/SynonymAsset" - }, - "qnas": { - "$ref": "#/definitions/ImportQnaAsset" - } - } - }, - "SynonymAssets": { - "type": "object", - "description": "All synonym assets for this project.", - "additionalProperties": false, - "properties": { - "value": { - "$ref": "#/definitions/SynonymAsset" - }, - "nextLink": { - "type": "string" - } - } - }, - "SynonymAsset": { - "type": "array", - "description": "Collection of synonyms.", - "additionalProperties": false, - "maxLength": 10000, - "items": { - "$ref": "#/definitions/WordAlterations" - } - }, - "WordAlterations": { - "type": "object", - "description": "Collection of word alterations.", - "additionalProperties": false, - "required": [ - "alterations" - ], - "properties": { - "alterations": { - "type": "array", - "description": "Collection of word alterations.", - "maxLength": 20, - "items": { - "type": "string" - } - } - } - }, - "QnaAssets": { - "type": "object", - "description": "All QnA assets for the project.", - "additionalProperties": false, - "properties": { - "value": { - "$ref": "#/definitions/QnaAsset" - }, - "nextLink": { - "type": "string" - } - } - }, - "ImportQnaAsset": { - "type": "array", - "description": "List of QnA records to import.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/ImportQnaRecord" - } - }, - "QnaAsset": { - "type": "array", - "description": "List of QnA records.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/RetrieveQnaRecord" - } - }, - "QnaRecord": { - "type": "object", - "description": "QnA record.", - "additionalProperties": false, - "properties": { - "id": { - "type": "integer", - "description": "Unique ID for the QnA.", - "format": "int32" - }, - "answer": { - "type": "string", - "description": "Answer text.", - "maxLength": 25000, - "minLength": 1 - }, - "source": { - "type": "string", - "description": "Source from which QnA was indexed e.g. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .", - "maxLength": 300 - }, - "questions": { - "type": "array", - "description": "List of questions associated with the answer.", - "maxLength": 100, - "minLength": 1, - "items": { - "type": "string" - } - }, - "metadata": { - "type": "object", - "description": "Metadata associated with the answer, useful to categorize or filter question answers.", - "additionalProperties": { - "type": "string" - } - }, - "dialog": { - "description": "Context of a QnA.", - "$ref": "#/definitions/QnaDialog" - }, - "activeLearningSuggestions": { - "type": "array", - "description": "List of Active Learning suggestions for the QnA.", - "items": { - "$ref": "#/definitions/SuggestedQuestionsCluster" - } - } - } - }, - "SuggestedQuestionsCluster": { - "type": "object", - "description": "Active Learning suggested questions cluster details.", - "additionalProperties": false, - "properties": { - "clusterHead": { - "type": "string", - "description": "Question chosen as the head of suggested questions cluster by Active Learning clustering algorithm." - }, - "suggestedQuestions": { - "type": "array", - "description": "List of all suggested questions for the QnA.", - "items": { - "$ref": "#/definitions/SuggestedQuestion" - } - } - } - }, - "SuggestedQuestion": { - "type": "object", - "description": "Question suggested by the Active Learning feature.", - "additionalProperties": false, - "properties": { - "question": { - "type": "string", - "description": "Question suggested by the Active Learning feature." - }, - "userSuggestedCount": { - "type": "integer", - "description": "The number of times the question was suggested explicitly by the user.", - "format": "int32" - }, - "autoSuggestedCount": { - "type": "integer", - "description": "The number of times the question was suggested automatically by the Active Learning algorithm.", - "format": "int32" - } - } - }, - "ImportQnaRecord": { - "description": "Import QnA Record.", - "allOf": [ - { - "$ref": "#/definitions/RetrieveQnaRecord" - }, - { - "$ref": "#/definitions/SourceDisplayNameParameter" - } - ] - }, - "SourceDisplayNameParameter": { - "type": "object", - "properties": { - "sourceDisplayName": { - "description": "Friendly name of the Source.", - "type": "string", - "maxLength": 200, - "minLength": 1 - } - } - }, - "RetrieveQnaRecord": { - "description": "QnA Record with last updated date-time.", - "allOf": [ - { - "$ref": "#/definitions/QnaRecord" - }, - { - "$ref": "#/definitions/LastUpdatedDateTimeParameter" - } - ] - }, - "LastUpdatedDateTimeParameter": { - "type": "object", - "description": "Last updated date-time parameter.", - "properties": { - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "Date-time when the QnA was last updated." - } - } - }, - "QnaDialog": { - "type": "object", - "description": "Dialog associated with QnA Record.", - "properties": { - "isContextOnly": { - "type": "boolean", - "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as answer for queries without context; otherwise, ignores context and includes this QnA in answers." - }, - "prompts": { - "type": "array", - "description": "List of prompts associated with the answer.", - "maxItems": 20, - "items": { - "$ref": "#/definitions/QnaPrompt" - } - } - } - }, - "QnaPrompt": { - "type": "object", - "description": "Prompt for an answer.", - "properties": { - "displayOrder": { - "type": "integer", - "description": "Index of the prompt. It is used for ordering of the prompts.", - "format": "int32" - }, - "qnaId": { - "type": "integer", - "description": "ID of the QnA corresponding to the prompt.", - "format": "int32" - }, - "qna": { - "description": "QnA record. Either QnAId or QnA record needs to be present in a Prompt.", - "$ref": "#/definitions/QnaRecord" - }, - "displayText": { - "type": "string", - "description": "Text displayed to represent a follow up question prompt.", - "maxLength": 200 - } - } - }, - "UpdateOperationKind": { - "type": "string", - "description": "Update operation type for assets.", - "enum": [ - "add", - "delete", - "replace" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "updateOperationKind" - } - }, - "UpdateSourcesOptions": { - "type": "array", - "description": "A list of sources to be updated.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/UpdateSourceRecord" - } - }, - "UpdateQnaOptions": { - "type": "array", - "description": "A list of QnAs to be updated.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/UpdateQnaRecord" - } - }, - "UpdateQnaRecord": { - "type": "object", - "description": "QnA record to be updated.", - "additionalProperties": false, - "required": [ - "op", - "value" - ], - "properties": { - "op": { - "type": "string", - "$ref": "#/definitions/UpdateOperationKind" - }, - "value": { - "$ref": "#/definitions/QnaRecord" - } - } - }, - "UpdateSourceRecord": { - "type": "object", - "description": "Source to be updated.", - "additionalProperties": false, - "required": [ - "op", - "value" - ], - "properties": { - "op": { - "type": "string", - "$ref": "#/definitions/UpdateOperationKind" - }, - "value": { - "$ref": "#/definitions/UpdateQnaSourceRecord" - } - } - }, - "QnaSources": { - "type": "object", - "description": "All QnA sources for the project.", - "additionalProperties": false, - "properties": { - "value": { - "$ref": "#/definitions/QnaSourcesMetadata" - }, - "nextLink": { - "type": "string" - } - } - }, - "QnaSourcesMetadata": { - "type": "array", - "description": "Custom sources from which QnAs were extracted or explicitly added to the project.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/QnaSourceRecord" - } - }, - "QnaSourceRecord": { - "description": "Custom source record with last updated date-time.", - "allOf": [ - { - "$ref": "#/definitions/QnaSourceMetadata" - }, - { - "$ref": "#/definitions/LastUpdatedDateTimeParameter" - } - ] - }, - "UpdateQnaSourceRecord": { - "description": "Update source record.", - "allOf": [ - { - "$ref": "#/definitions/QnaSourceMetadata" - }, - { - "$ref": "#/definitions/RefreshSourceOptions" - } - ] - }, - "RefreshSourceOptions": { - "type": "object", - "description": "Boolean flag used to refresh data from the Source.", - "properties": { - "refresh": { - "type": "boolean", - "description": "Boolean flag used to refresh data from the Source." - } - } - }, - "QnaSourceMetadata": { - "type": "object", - "description": "Input source file or url details.", - "additionalProperties": false, - "required": [ - "sourceUri", - "sourceKind", - "source" - ], - "properties": { - "displayName": { - "type": "string", - "description": "Friendly name of the Source.", - "maxLength": 200, - "minLength": 1 - }, - "source": { - "type": "string", - "description": "Unique source identifier. Name of the file if it's a 'file' source; otherwise, the complete URL if it's a 'url' source." - }, - "sourceUri": { - "type": "string", - "description": "URI location for the file or url.", - "format": "uri" - }, - "sourceKind": { - "type": "string", - "$ref": "#/definitions/QnaSourceKind", - "default": "url" - }, - "contentStructureKind": { - "type": "string", - "$ref": "#/definitions/SourceContentStructureKind", - "default": "Unstructured" - } - } - }, - "QnaSourceKind": { - "type": "string", - "description": "Supported source types.", - "x-ms-enum": { - "name": "sourceKind", - "modelAsString": true - }, - "enum": [ - "file", - "url" - ] - }, - "SourceContentStructureKind": { - "type": "string", - "description": "Content structure type for sources.", - "enum": [ - "unstructured" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "sourceContentStructureKind" - } - }, - "ProjectDeployments": { - "type": "object", - "description": "All deployments of a project.", - "additionalProperties": false, - "properties": { - "value": { - "$ref": "#/definitions/ProjectDeploymentsList" - }, - "nextLink": { - "type": "string" - } - } - }, - "ProjectDeploymentsList": { - "type": "array", - "description": "List of deployments of a project.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/ProjectDeployment" - } - }, - "ProjectDeployment": { - "type": "object", - "description": "Project deployment details.", - "additionalProperties": false, - "properties": { - "deploymentName": { - "type": "string", - "description": "Name of the deployment." - }, - "lastDeployedDateTime": { - "type": "string", - "description": "Represents the project last deployment date-time.", - "format": "date-time" - } - } - } - }, - "parameters": { - "JobIdParameter": { - "name": "jobId", - "in": "path", - "description": "Job ID.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AssetKindParameter": { - "name": "assetKind", - "type": "string", - "in": "query", - "description": "Kind of the asset of the project.", - "enum": [ - "qnas", - "synonyms" - ], - "x-ms-parameter-location": "method" - }, - "ImportExportFormatParameter": { - "name": "format", - "type": "string", - "in": "query", - "description": "Knowledge base Import or Export format.", - "default": "json", - "enum": [ - "json", - "tsv", - "excel" - ], - "x-ms-enum": { - "name": "format", - "modelAsString": true, - "values": [ - { - "value": "json", - "description": "Export or Import QnA assets in JSON format." - }, - { - "value": "tsv", - "description": "Export or Import knowledge base replica including all assets and metadata in Excel format." - }, - { - "value": "excel", - "description": "Export or Import knowledge base replica including all assets and metadata in Tsv format." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "SourceFilterParameter": { - "name": "source", - "in": "query", - "description": "Source of the QnA.", - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/questionanswering.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/questionanswering.json deleted file mode 100644 index 02b4be414f0d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/questionanswering.json +++ /dev/null @@ -1,601 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Question Answering", - "description": "The Language Service API is a suite of natural language processing (NLP) skills built with Microsoft machine learning algorithms. You can use the API to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection, and question answering. You can find more documentation in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2022-10-01-preview" - }, - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) flows. When you pair them with [Azure role-based access control (RBAC)](https://docs.microsoft.com/azure/role-based-access-control/overview), you can use them to control access to Azure Maps REST APIs. You use RBAC to designate access to one or more Azure Maps resource accounts or subresources. You can grant any user, group, or service principal access via a built-in role or a custom role that consists of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling applications via objects that are capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. You can get this header from the [Azure Maps management API](https://aka.ms/amauthdetails).\n* \nThe authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique authorization URLs and Azure Active Directory configurations. \n* \nYou configure RBAC from the [Azure management plane](https://aka.ms/amrbac) via the Azure portal, PowerShell, the Azure CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration-based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports work, school, and guest accounts but does not support personal accounts.", - "scopes": { - "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" - } - }, - "apim_key": { - "type": "apiKey", - "description": "Subscription key for a language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://cognitiveservices.azure.com/.default" - ] - }, - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/:query-knowledgebases": { - "post": { - "summary": "Answers the specified question using your knowledge base.", - "operationId": "QuestionAnswering_GetAnswers", - "parameters": [ - { - "$ref": "#/parameters/AnswersOptions" - }, - { - "$ref": "common.json#/parameters/ProjectNameQueryParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNameQueryParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Successful response to get answers from the knowledge base.", - "schema": { - "$ref": "#/definitions/AnswersResult" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/SuccessfulQueryKnowledgebases.json" - } - } - } - }, - "/:query-text": { - "post": { - "summary": "Answers the specified question by using the provided text in the body.", - "operationId": "QuestionAnswering_GetAnswersFromText", - "parameters": [ - { - "$ref": "#/parameters/AnswersFromTextOptions" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Successful response to get answers from input text.", - "schema": { - "$ref": "#/definitions/AnswersFromTextResult" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/SuccessfulQueryText.json" - } - } - } - } - }, - "definitions": { - "AnswersOptions": { - "type": "object", - "description": "Parameters to query a knowledge base.", - "additionalProperties": false, - "properties": { - "qnaId": { - "type": "integer", - "description": "Exact question-and-answer (QnA) ID to fetch from the knowledge base. This field takes priority over the question.", - "format": "int32" - }, - "question": { - "type": "string", - "description": "User question to query against the knowledge base." - }, - "top": { - "type": "integer", - "description": "Maximum number of answers to be returned for the question.", - "format": "int32" - }, - "userId": { - "type": "string", - "description": "Unique identifier for the user." - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidenceThreshold", - "description": "Minimum threshold score for answers. The value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "context": { - "x-ms-client-name": "answerContext", - "description": "Context object with the previous QnA's information.", - "$ref": "#/definitions/KnowledgeBaseAnswerContext" - }, - "rankerType": { - "type": "string", - "x-ms-client-name": "rankerKind", - "description": "Type of ranker to be used.", - "x-ms-enum": { - "name": "RankerKind", - "modelAsString": true, - "values": [ - { - "value": "QuestionOnly", - "description": "Question-only ranker." - }, - { - "value": "Default", - "description": "Default ranker." - } - ] - }, - "enum": [ - "Default", - "QuestionOnly" - ] - }, - "filters": { - "description": "Filter QnAs based on a metadata list and knowledge base sources.", - "$ref": "#/definitions/QueryFilters" - }, - "answerSpanRequest": { - "x-ms-client-name": "shortAnswerOptions", - "description": "To configure the answer span prediction feature.", - "$ref": "#/definitions/ShortAnswerOptions" - }, - "includeUnstructuredSources": { - "type": "boolean", - "description": "Flag to enable a query over unstructured sources." - } - } - }, - "ShortAnswerOptions": { - "type": "object", - "description": "To configure the answer span prediction feature.", - "additionalProperties": false, - "required": [ - "enable" - ], - "properties": { - "enable": { - "type": "boolean", - "description": "Enable or disable answer span prediction.", - "enum": [ - true - ], - "x-ms-enum": { - "name": "enable", - "modelAsString": false - } - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidenceThreshold", - "description": "Minimum threshold score required to include an answer span. The value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "topAnswersWithSpan": { - "type": "integer", - "x-ms-client-name": "top", - "description": "Number of top answers to be considered for span prediction, from 1 to 10.", - "format": "int32", - "maximum": 10, - "minimum": 1 - } - } - }, - "KnowledgeBaseAnswerContext": { - "type": "object", - "description": "Context object with the previous QnA's information.", - "additionalProperties": false, - "required": [ - "previousQnaId" - ], - "properties": { - "previousQnaId": { - "type": "integer", - "description": "Previous turn's top answer result for the QnA ID.", - "format": "int32" - }, - "previousUserQuery": { - "type": "string", - "x-ms-client-name": "previousQuestion", - "description": "Previous user query." - } - } - }, - "AnswersResult": { - "type": "object", - "description": "Represents a list of questions and answers.", - "additionalProperties": false, - "properties": { - "answers": { - "type": "array", - "description": "Represents an answer result list.", - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswer" - } - } - } - }, - "KnowledgeBaseAnswer": { - "type": "object", - "description": "Represents a knowledge base answer.", - "additionalProperties": false, - "properties": { - "questions": { - "type": "array", - "description": "List of questions associated with the answer.", - "items": { - "type": "string" - } - }, - "answer": { - "type": "string", - "description": "Answer text." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidence", - "description": "Answer confidence score. The value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "id": { - "type": "integer", - "x-ms-client-name": "qnaId", - "description": "ID of the QnA result.", - "format": "int32" - }, - "source": { - "type": "string", - "description": "Source of the QnA result." - }, - "metadata": { - "type": "object", - "description": "Metadata associated with the answer, which is useful to categorize or filter answers.", - "additionalProperties": { - "type": "string" - } - }, - "dialog": { - "type": "object", - "$ref": "#/definitions/KnowledgeBaseAnswerDialog" - }, - "answerSpan": { - "type": "object", - "x-ms-client-name": "shortAnswer", - "description": "Answer span object of the QnA with respect to the user's question.", - "$ref": "#/definitions/AnswerSpan" - } - } - }, - "KnowledgeBaseAnswerDialog": { - "type": "object", - "description": "Dialog associated with the answer.", - "properties": { - "isContextOnly": { - "type": "boolean", - "description": "To mark if a prompt is relevant only with a previous question. If true, the dialog won't include this QnA as a search result for queries without context. If false, the dialog will ignore context and include this QnA in the search result." - }, - "prompts": { - "type": "array", - "description": "List of prompts associated with the answer.", - "maxItems": 20, - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswerPrompt" - } - } - } - }, - "KnowledgeBaseAnswerPrompt": { - "type": "object", - "description": "Prompt for an answer.", - "properties": { - "displayOrder": { - "type": "integer", - "description": "Index of the prompt, which is used in the ordering of prompts.", - "format": "int32" - }, - "qnaId": { - "type": "integer", - "description": "QnA ID that corresponds to the prompt.", - "format": "int32" - }, - "displayText": { - "type": "string", - "description": "Text displayed to represent a follow-up question prompt.", - "maxLength": 200 - } - } - }, - "QueryFilters": { - "type": "object", - "description": "Filters over the knowledge base.", - "additionalProperties": false, - "properties": { - "metadataFilter": { - "type": "object", - "$ref": "#/definitions/MetadataFilter" - }, - "sourceFilter": { - "type": "object", - "$ref": "#/definitions/SourceFilter" - }, - "logicalOperation": { - "type": "string", - "description": "Logical operation that's used to join the metadata filter with the source filter.", - "$ref": "#/definitions/LogicalOperationKind", - "default": "AND" - } - } - }, - "MetadataFilter": { - "type": "object", - "description": "Find QnAs that are associated with the list of metadata.", - "additionalProperties": false, - "properties": { - "metadata": { - "type": "array", - "items": { - "$ref": "#/definitions/MetadataRecord" - } - }, - "logicalOperation": { - "type": "string", - "description": "Operation that's used to join metadata filters.", - "$ref": "#/definitions/LogicalOperationKind", - "default": "AND" - } - } - }, - "MetadataRecord": { - "type": "object", - "description": "Object to provide the key/value pair for each metadata item.", - "additionalProperties": false, - "required": [ - "key", - "value" - ], - "properties": { - "key": { - "type": "string", - "description": "Metadata key from the metadata dictionary that's used in the QnA." - }, - "value": { - "type": "string", - "description": "Metadata value from the metadata dictionary that's used in the QnA." - } - } - }, - "LogicalOperationKind": { - "type": "string", - "description": "Set to OR or AND for using the corresponding logical operation.", - "x-ms-enum": { - "name": "LogicalOperationKind", - "modelAsString": true - }, - "enum": [ - "AND", - "OR" - ] - }, - "SourceFilter": { - "type": "array", - "description": "Find QnAs that are associated with any of the listed sources in the knowledge base.", - "items": { - "type": "string" - } - }, - "AnswerSpan": { - "type": "object", - "description": "Answer span object of the QnA.", - "additionalProperties": false, - "properties": { - "text": { - "type": "string", - "description": "Predicted text of the answer span." - }, - "confidenceScore": { - "type": "number", - "x-ms-client-name": "confidence", - "description": "Predicted score of the answer span. The value ranges from 0 to 1.", - "format": "double", - "maximum": 1, - "minimum": 0 - }, - "offset": { - "type": "integer", - "description": "Answer span offset from the start of the answer.", - "format": "int32" - }, - "length": { - "type": "integer", - "description": "Length of the answer span.", - "format": "int32" - } - } - }, - "AnswersFromTextOptions": { - "type": "object", - "description": "Question and text record parameters to answer.", - "required": [ - "question", - "records" - ], - "additionalProperties": false, - "properties": { - "question": { - "type": "string", - "description": "User question to query against the text records." - }, - "records": { - "type": "array", - "x-ms-client-name": "textDocuments", - "description": "Text records to be searched for the question.", - "items": { - "$ref": "#/definitions/TextDocument" - } - }, - "language": { - "$ref": "common.json#/definitions/Language" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - } - }, - "AnswersFromTextResult": { - "type": "object", - "description": "Represents the answer results.", - "additionalProperties": false, - "properties": { - "answers": { - "type": "array", - "description": "Represents the answer results.", - "items": { - "$ref": "#/definitions/TextAnswer" - } - } - } - }, - "TextAnswer": { - "type": "object", - "description": "Represents the answer result.", - "additionalProperties": false, - "properties": { - "answer": { - "type": "string", - "description": "Answer." - }, - "confidenceScore": { - "type": "number", - "x-ms-client-name": "confidence", - "description": "Answer confidence score. The value ranges from 0 to 1.", - "format": "double", - "maximum": 1, - "minimum": 0 - }, - "id": { - "type": "string", - "description": "Record ID." - }, - "answerSpan": { - "type": "object", - "x-ms-client-name": "shortAnswer", - "description": "Answer span object with respect to the user's question.", - "$ref": "#/definitions/AnswerSpan" - }, - "offset": { - "type": "integer", - "description": "Sentence offset from the start of the document.", - "format": "int32" - }, - "length": { - "type": "integer", - "description": "Length of the sentence.", - "format": "int32" - } - } - }, - "TextDocument": { - "type": "object", - "description": "Represents the input text record to be queried.", - "additionalProperties": false, - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the text record." - }, - "text": { - "type": "string", - "description": "Text contents of the record." - } - } - } - }, - "parameters": { - "AnswersOptions": { - "name": "knowledgeBaseQueryOptions", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AnswersOptions" - }, - "x-nullable": true, - "description": "POST body of the request.", - "x-ms-parameter-location": "method" - }, - "AnswersFromTextOptions": { - "name": "textQueryOptions", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AnswersFromTextOptions" - }, - "x-nullable": true, - "description": "POST body of the request.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations-authoring.json deleted file mode 100644 index dbe0cc2bf812..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations-authoring.json +++ /dev/null @@ -1,5216 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Analyze Conversations Authoring", - "version": "2023-04-15-preview", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://learn.microsoft.com/en-us/azure/cognitive-services/language-service/overview.", - "x-typespec-generated": [ - { - "emitter": "@azure-tools/typespec-autorest" - } - ] - }, - "schemes": [ - "https" - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "name": "Endpoint", - "in": "path", - "description": "Supported Cognitive Services endpoint e.g., https://.api.cognitiveservices.azure.com.", - "required": true, - "type": "string" - } - ] - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "security": [ - { - "ApiKeyAuth": [] - }, - { - "OAuth2Auth": [ - "https://cognitiveservices.azure.com/.default" - ] - } - ], - "securityDefinitions": { - "ApiKeyAuth": { - "type": "apiKey", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - }, - "OAuth2Auth": { - "type": "oauth2", - "flow": "accessCode", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "https://cognitiveservices.azure.com/.default": "" - }, - "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" - } - }, - "tags": [], - "paths": { - "/authoring/analyze-conversations/projects": { - "get": { - "operationId": "ConversationAuthoringListProjects", - "description": "Lists the existing projects.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedAnalyzeConversationAuthoringProjectMetadata" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful List Projects": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListProjects.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}": { - "get": { - "operationId": "ConversationAuthoringProject_GetProject", - "description": "Gets the details of a project.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringProjectMetadata" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProject.json" - } - } - }, - "patch": { - "operationId": "ConversationAuthoringProject_CreateProject", - "description": "Creates a new project or updates an existing one.", - "consumes": [ - "application/merge-patch+json" - ], - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "body", - "in": "body", - "description": "The request body", - "required": true, - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringCreateProjectOptions" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringProjectMetadata" - } - }, - "201": { - "description": "The request has succeeded and a new resource has been created as a result.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringProjectMetadata" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Create Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateProject.json" - } - } - }, - "delete": { - "operationId": "ConversationAuthoringProject_DeleteProject", - "description": "Deletes a project.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string", - "maxLength": 100 - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Delete Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/:authorize-copy": { - "post": { - "operationId": "ConversationAuthoringProject_CopyProjectAuthorization", - "description": "Generates a copy project operation authorization to the current target Azure resource.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringCopyAuthorizationOptions" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringCopiedProjectOptions" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Copy Project Authorization": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/:copy": { - "post": { - "operationId": "ConversationAuthoringProject_CopyProject", - "description": "Copies an existing project to another Azure resource.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "body", - "in": "body", - "description": "The copy project info.", - "required": true, - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringCopiedProjectOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Copy Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCopyProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/:export": { - "post": { - "operationId": "ConversationAuthoringProject_Export", - "description": "Triggers a job to export a project's data.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "format", - "in": "query", - "description": "The format of the exported project file to use.", - "required": false, - "type": "string", - "enum": [ - "Conversation", - "Luis" - ], - "x-ms-enum": { - "name": "ExportedProjectFormat", - "modelAsString": true, - "values": [ - { - "name": "Conversation", - "value": "Conversation", - "description": "Specifies the format for a conversational project." - }, - { - "name": "Luis", - "value": "Luis", - "description": "Specifies the format for an application that was exported from LUIS." - } - ] - }, - "x-ms-client-name": "ExportedProjectFormat" - }, - { - "name": "stringIndexType", - "in": "query", - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "required": true, - "type": "string", - "enum": [ - "Utf16CodeUnit", - "Utf8CodeUnit", - "Utf32CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "name": "Utf16CodeUnit", - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - }, - { - "name": "Utf8CodeUnit", - "value": "Utf8CodeUnit" - }, - { - "name": "Utf32CodeUnit", - "value": "Utf32CodeUnit" - } - ] - } - }, - { - "name": "assetKind", - "in": "query", - "description": "Kind of asset to export.", - "required": false, - "type": "string" - }, - { - "name": "trainedModelLabel", - "in": "query", - "description": "Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy.", - "required": false, - "type": "string" - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Export Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulExportProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/:import": { - "post": { - "operationId": "ConversationAuthoringProject_Import", - "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "format", - "in": "query", - "description": "The format of the exported project file to use.", - "required": false, - "type": "string", - "enum": [ - "Conversation", - "Luis" - ], - "x-ms-enum": { - "name": "ExportedProjectFormat", - "modelAsString": true, - "values": [ - { - "name": "Conversation", - "value": "Conversation", - "description": "Specifies the format for a conversational project." - }, - { - "name": "Luis", - "value": "Luis", - "description": "Specifies the format for an application that was exported from LUIS." - } - ] - }, - "x-ms-client-name": "ExportedProjectFormat" - }, - { - "name": "body", - "in": "body", - "description": "The project data to import.", - "required": true, - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedProject" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Import Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulImportProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/:train": { - "post": { - "operationId": "ConversationAuthoringProject_Train", - "description": "Triggers a training job for a project.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "body", - "in": "body", - "description": "The training input parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringTrainingJobOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Train Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulTrainProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/copy/jobs/{jobId}": { - "get": { - "operationId": "ConversationAuthoringProject_GetCopyProjectStatus", - "description": "Gets the status of an existing copy project job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringCopiedProjectJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Copy Project Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments": { - "get": { - "operationId": "ConversationAuthoringListDeployments", - "description": "Lists the deployments belonging to a project.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedAnalyzeConversationAuthoringProjectDeployment" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful List Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeployments.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": { - "get": { - "operationId": "ConversationAuthoringDeployment_GetDeployment", - "description": "Gets the details of a deployment.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "deploymentName", - "in": "path", - "description": "Represents deployment name.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringProjectDeployment" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeployment.json" - } - } - }, - "put": { - "operationId": "ConversationAuthoringDeployment_DeployProject", - "description": "Creates a new deployment or replaces an existing one.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "deploymentName", - "in": "path", - "description": "The name of the specific deployment of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The new deployment info.", - "required": true, - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringCreateDeploymentOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Deploy Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeployProject.json" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "operationId": "ConversationAuthoringDeployment_DeleteDeployment", - "description": "Deletes a project deployment.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "deploymentName", - "in": "path", - "description": "The name of the specific deployment of the project to use.", - "required": true, - "type": "string" - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Delete Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources": { - "post": { - "operationId": "ConversationAuthoringDeployment_DeleteDeploymentFromResources", - "description": "Deletes a project deployment from the specified assigned resources.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "deploymentName", - "in": "path", - "description": "The name of the specific deployment of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The options for deleting the deployment.", - "required": true, - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringDeleteDeploymentOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Delete Deployment From Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}": { - "get": { - "operationId": "ConversationAuthoringDeployment_GetDeploymentDeleteFromResourcesStatus", - "description": "Gets the status of an existing delete deployment from specific resources job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "deploymentName", - "in": "path", - "description": "Represents deployment name.", - "required": true, - "type": "string" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentDeleteFromResourcesJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Deployment Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { - "get": { - "operationId": "ConversationAuthoringDeployment_GetDeploymentStatus", - "description": "Gets the status of an existing deployment job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "deploymentName", - "in": "path", - "description": "Represents deployment name.", - "required": true, - "type": "string" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Deployment Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { - "post": { - "operationId": "ConversationAuthoringProject_SwapDeployments", - "description": "Swaps two existing deployments with each other.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "body", - "in": "body", - "description": "The job object to swap two deployments.", - "required": true, - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringSwapDeploymentsOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Swap Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { - "get": { - "operationId": "ConversationAuthoringProject_GetSwapDeploymentsStatus", - "description": "Gets the status of an existing swap deployment job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringSwapDeploymentsJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Swap Deployments Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": { - "get": { - "operationId": "ConversationAuthoringProject_GetExportStatus", - "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportProjectJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Export Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { - "get": { - "operationId": "ConversationAuthoringProject_GetImportStatus", - "description": "Gets the status for an import.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringImportProjectJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Import Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models": { - "get": { - "operationId": "ConversationAuthoringListTrainedModels", - "description": "Lists the trained models belonging to a project.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedAnalyzeConversationAuthoringProjectTrainedModel" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful List Models": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListModels.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": { - "get": { - "operationId": "ConversationAuthoringTrainedModel_GetTrainedModel", - "description": "Gets the details of a trained model.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "trainedModelLabel", - "in": "path", - "description": "The trained model label.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringProjectTrainedModel" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModel.json" - } - } - }, - "delete": { - "operationId": "ConversationAuthoringTrainedModel_DeleteTrainedModel", - "description": "Deletes an existing trained model.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "trainedModelLabel", - "in": "path", - "description": "The trained model label.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Delete Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteModel.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:evaluate": { - "post": { - "operationId": "ConversationAuthoringTrainedModel_EvaluateModel", - "description": "Triggers evaluation operation on a trained model.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "trainedModelLabel", - "in": "path", - "description": "The trained model label.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The training input parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Evaluation Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot": { - "post": { - "operationId": "ConversationAuthoringTrainedModel_LoadSnapshot", - "description": "Restores the snapshot of this trained model to be the current working directory of the project.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "trainedModelLabel", - "in": "path", - "description": "The trained model label.", - "required": true, - "type": "string" - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Load Snapshot": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluate/jobs/{jobId}": { - "get": { - "operationId": "ConversationAuthoringTrainedModel_GetEvaluationStatus", - "description": "Gets the status for an evaluation job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "trainedModelLabel", - "in": "path", - "description": "The trained model label.", - "required": true, - "type": "string" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Evaluation Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { - "get": { - "operationId": "ConversationAuthoringTrainedModel_GetModelEvaluationResults", - "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "trainedModelLabel", - "in": "path", - "description": "The trained model label.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - }, - { - "$ref": "#/parameters/StringIndexTypeQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedAnalyzeConversationAuthoringUtteranceEvaluationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Model Evaluation": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { - "get": { - "operationId": "ConversationAuthoringTrainedModel_GetModelEvaluationSummary", - "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "trainedModelLabel", - "in": "path", - "description": "The trained model label.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationSummary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Model Evaluation Summary": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}": { - "get": { - "operationId": "ConversationAuthoringTrainedModel_GetLoadSnapshotStatus", - "description": "Gets the status for loading a snapshot.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "trainedModelLabel", - "in": "path", - "description": "The trained model label.", - "required": true, - "type": "string" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringLoadSnapshotJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Load Snapshot Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/resources": { - "get": { - "operationId": "ConversationAuthoringListDeploymentResources", - "description": "Lists the deployments resources assigned to the project.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedAnalyzeConversationAuthoringAssignedDeploymentResource" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful List Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/resources/:assign": { - "post": { - "operationId": "ConversationAuthoringProject_AssignDeploymentResources", - "description": "Assign new Azure resources to a project to allow deploying new deployments to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "body", - "in": "body", - "description": "The new project resources info.", - "required": true, - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringAssignDeploymentResourcesOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Assign Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/resources/:unassign": { - "post": { - "operationId": "ConversationAuthoringProject_UnassignDeploymentResources", - "description": "Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "body", - "in": "body", - "description": "The info for the deployment resources to be deleted.", - "required": true, - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringUnassignDeploymentResourcesOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Unassign Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/{projectName}/resources/assign/jobs/{jobId}": { - "get": { - "operationId": "ConversationAuthoringProject_GetAssignDeploymentResourcesStatus", - "description": "Gets the status of an existing assign deployment resources job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentResourcesJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Assign Deployment Resources Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}": { - "get": { - "operationId": "ConversationAuthoringProject_GetUnassignDeploymentResourcesStatus", - "description": "Gets the status of an existing unassign deployment resources job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentResourcesJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Unassign Deployment Resources Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/train/jobs": { - "get": { - "operationId": "ConversationAuthoringListTrainingJobs", - "description": "Lists the non-expired training jobs created for a project.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedAnalyzeConversationAuthoringTrainingJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful List Training Jobs": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": { - "get": { - "operationId": "ConversationAuthoringProject_GetTrainingStatus", - "description": "Gets the status for a training job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringTrainingJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Train Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": { - "post": { - "operationId": "ConversationAuthoringProject_CancelTrainingJob", - "description": "Triggers a cancellation for a running training job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string", - "maxLength": 100 - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Cancel Training Job": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": { - "get": { - "operationId": "ConversationAuthoringProject_GetProjectDeletionStatus", - "description": "Gets the status for a project deletion job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationAuthoringProjectDeletionJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Project Deletion Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json" - } - } - } - }, - "/authoring/analyze-conversations/projects/global/deployments/resources": { - "get": { - "operationId": "ConversationAuthoringListAssignedResourceDeployments", - "description": "Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedAnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful List Assigned Resource Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-conversations/projects/global/languages": { - "get": { - "operationId": "ConversationAuthoringListSupportedLanguages", - "description": "Lists the supported languages for the given project type.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - }, - { - "$ref": "#/parameters/ProjectKindQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedAnalyzeConversationAuthoringSupportedLanguage" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Supported Languages": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-conversations/projects/global/prebuilt-entities": { - "get": { - "operationId": "ConversationAuthoringListSupportedPrebuiltEntities", - "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - }, - { - "$ref": "#/parameters/SupportedPrebuiltEntitiesQueryParameter.language" - }, - { - "$ref": "#/parameters/SupportedPrebuiltEntitiesQueryParameter.multilingual" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedAnalyzeConversationAuthoringPrebuiltEntity" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Supported Prebuilt Entities": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-conversations/projects/global/training-config-versions": { - "get": { - "operationId": "ConversationAuthoringListTrainingConfigVersions", - "description": "Lists the support training config version for a given project type.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - }, - { - "$ref": "#/parameters/ProjectKindQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedAnalyzeConversationAuthoringTrainingConfigVersion" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Get Supported Training Config Versions": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "AnalyzeConversationAuthoringAssignDeploymentResourcesOptions": { - "type": "object", - "description": "Represents the options for assigning Azure resources to a project.", - "properties": { - "resourcesMetadata": { - "type": "array", - "description": "Represents the metadata for the resources to be assigned.", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringResourceMetadata" - } - } - }, - "required": [ - "resourcesMetadata" - ] - }, - "AnalyzeConversationAuthoringAssignedDeploymentResource": { - "type": "object", - "description": "Represents the assigned deployment resource.", - "properties": { - "azureResourceId": { - "type": "string", - "description": "The resource ID.", - "readOnly": true - }, - "region": { - "type": "string", - "description": "The resource region." - } - }, - "required": [ - "azureResourceId", - "region" - ] - }, - "AnalyzeConversationAuthoringAssignedProjectDeploymentMetadata": { - "type": "object", - "description": "Represents the metadata for an assigned deployment", - "properties": { - "deploymentName": { - "type": "string", - "description": "Represents the deployment name." - }, - "lastDeployedDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents deployment last deployed time." - }, - "deploymentExpirationDate": { - "type": "string", - "format": "date", - "description": "Represents deployment expiration date in the runtime." - } - }, - "required": [ - "deploymentName", - "lastDeployedDateTime", - "deploymentExpirationDate" - ] - }, - "AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata": { - "type": "object", - "description": "Represents the metadata for assigned deployments for a project.", - "properties": { - "projectName": { - "type": "string", - "description": "Represents the project name.", - "readOnly": true - }, - "deploymentsMetadata": { - "type": "array", - "description": "Represents the resource region.", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringAssignedProjectDeploymentMetadata" - } - } - }, - "required": [ - "projectName", - "deploymentsMetadata" - ] - }, - "AnalyzeConversationAuthoringConfusionMatrixCell": { - "type": "object", - "description": "Represents a cell in a confusion matrix.", - "properties": { - "normalizedValue": { - "type": "number", - "format": "float", - "description": "Represents normalized value in percentages." - }, - "rawValue": { - "type": "number", - "format": "float", - "description": "Represents raw value." - } - }, - "required": [ - "normalizedValue", - "rawValue" - ] - }, - "AnalyzeConversationAuthoringConfusionMatrixRow": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AnalyzeConversationAuthoringConfusionMatrixCell" - } - }, - "AnalyzeConversationAuthoringConversationExportedEntity": { - "type": "object", - "description": "Represents an entity with its components.", - "properties": { - "category": { - "type": "string", - "description": "The category of the entity." - }, - "compositionSetting": { - "$ref": "#/definitions/CompositionSetting", - "description": "The behavior to follow when the entity's components overlap with each other." - }, - "entities": { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntityList", - "description": "The list component of the entity." - }, - "prebuilts": { - "type": "array", - "description": "The prebuilt entities components.", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedPrebuiltEntity" - } - }, - "regex": { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntityRegex", - "description": "The regex component of the entity." - }, - "requiredComponents": { - "type": "array", - "description": "The required components. Allowed values are 'learned', 'list', 'prebuilts' and 'regex'.", - "items": { - "type": "string" - } - } - }, - "required": [ - "category" - ] - }, - "AnalyzeConversationAuthoringConversationExportedIntent": { - "type": "object", - "description": "Represents an exported intent of a conversational project.", - "properties": { - "category": { - "type": "string", - "description": "The intent category." - } - }, - "required": [ - "category" - ] - }, - "AnalyzeConversationAuthoringConversationExportedProjectAsset": { - "type": "object", - "description": "Represents the exported assets of a conversational project.", - "properties": { - "intents": { - "type": "array", - "description": "The intents defined in the project.", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringConversationExportedIntent" - } - }, - "entities": { - "type": "array", - "description": "The entities defined in the project.", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringConversationExportedEntity" - } - }, - "utterances": { - "type": "array", - "description": "The utterances defined in the project.", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringConversationExportedUtterance" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedProjectAssets" - } - ], - "x-ms-discriminator-value": "Conversation" - }, - "AnalyzeConversationAuthoringConversationExportedUtterance": { - "type": "object", - "description": "Represents an exported utterance for a conversational project.", - "properties": { - "entities": { - "type": "array", - "description": "Represents the entity labels of the utterance.", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedUtteranceEntityLabel" - } - }, - "text": { - "type": "string", - "description": "The utterance text." - }, - "language": { - "type": "string", - "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - }, - "intent": { - "type": "string", - "description": "The intent of the utterance." - }, - "dataset": { - "$ref": "#/definitions/DatasetType", - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'." - } - }, - "required": [ - "text", - "intent" - ] - }, - "AnalyzeConversationAuthoringCopiedProjectJobState": { - "type": "object", - "description": "Represents the state of a copy job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "AnalyzeConversationAuthoringCopiedProjectOptions": { - "type": "object", - "description": "Represents the options for copying an existing project to another Azure resource.", - "properties": { - "projectKind": { - "$ref": "#/definitions/ProjectKind", - "description": "Represents the project kind." - }, - "targetProjectName": { - "type": "string", - "description": "The project name to be copied-into." - }, - "accessToken": { - "type": "string", - "description": "The access token." - }, - "expiresAt": { - "type": "string", - "format": "date-time", - "description": "The expiration of the access token." - }, - "targetResourceId": { - "type": "string", - "description": "Represents the target Azure resource ID." - }, - "targetResourceRegion": { - "type": "string", - "description": "Represents the target Azure resource region." - } - }, - "required": [ - "projectKind", - "targetProjectName", - "accessToken", - "expiresAt", - "targetResourceId", - "targetResourceRegion" - ] - }, - "AnalyzeConversationAuthoringCopyAuthorizationOptions": { - "type": "object", - "description": "Represents the options for authorizing a project copy to the current Azure resource.", - "properties": { - "projectKind": { - "$ref": "#/definitions/ProjectKind", - "description": "Represents the project kind." - }, - "storageInputContainerName": { - "type": "string", - "description": "The name of the storage container." - }, - "allowOverwrite": { - "type": "boolean", - "description": "Whether to allow an existing project to be overwritten using the resulting copy authorization." - } - }, - "required": [ - "projectKind" - ] - }, - "AnalyzeConversationAuthoringCreateDeploymentOptions": { - "type": "object", - "description": "Represents the options for creating or updating a project deployment.", - "properties": { - "trainedModelLabel": { - "type": "string", - "description": "Represents the trained model label." - }, - "assignedResourceIds": { - "type": "array", - "description": "Represents the resource IDs to be assigned to the deployment. If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created.", - "items": { - "type": "string" - } - } - }, - "required": [ - "trainedModelLabel" - ] - }, - "AnalyzeConversationAuthoringCreateProjectOptions": { - "type": "object", - "description": "Represents the options used to create or update a project.", - "properties": { - "projectKind": { - "$ref": "#/definitions/ProjectKind", - "description": "Represents the project kind." - }, - "settings": { - "$ref": "#/definitions/AnalyzeConversationAuthoringProjectSettings", - "description": "The project settings." - }, - "storageInputContainerName": { - "type": "string", - "description": "The storage container name in case of conversation summarization." - }, - "projectName": { - "type": "string", - "description": "The new project name." - }, - "multilingual": { - "type": "boolean", - "description": "Whether the project would be used for multiple languages or not." - }, - "description": { - "type": "string", - "description": "The project description." - }, - "language": { - "type": "string", - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - } - }, - "required": [ - "projectKind", - "projectName", - "language" - ] - }, - "AnalyzeConversationAuthoringDeleteDeploymentOptions": { - "type": "object", - "description": "Represents the options for deleting a project deployment.", - "properties": { - "assignedResourceIds": { - "type": "array", - "description": "Represents the resource IDs to delete the deployment from. If not provided, the deployment will be rolled out from all the resources it is deployed to. If provided, it will delete the deployment only from the specified assigned resources, and leave it for the rest.", - "items": { - "type": "string" - } - } - } - }, - "AnalyzeConversationAuthoringDeploymentDeleteFromResourcesJobState": { - "type": "object", - "description": "Represents the state of an existing delete deployment from specific resources job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "AnalyzeConversationAuthoringDeploymentJobState": { - "type": "object", - "description": "Represents the state of a deployment job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "AnalyzeConversationAuthoringDeploymentResource": { - "type": "object", - "description": "Represents an Azure resource assigned to a deployment.", - "properties": { - "resourceId": { - "type": "string", - "description": "Represents the Azure resource Id." - }, - "region": { - "type": "string", - "description": "Represents the resource region." - } - }, - "required": [ - "resourceId", - "region" - ] - }, - "AnalyzeConversationAuthoringDeploymentResourcesJobState": { - "type": "object", - "description": "Represents the state of a deployment resources job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "AnalyzeConversationAuthoringEntitiesEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation result summary for the project's entities.", - "properties": { - "confusionMatrix": { - "type": "object", - "description": "Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted.", - "additionalProperties": { - "$ref": "#/definitions/AnalyzeConversationAuthoringConfusionMatrixRow" - } - }, - "entities": { - "type": "object", - "description": "Represents the entities evaluation summary.", - "additionalProperties": { - "$ref": "#/definitions/AnalyzeConversationAuthoringEntityEvaluationSummary" - } - }, - "microF1": { - "type": "number", - "format": "float", - "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." - }, - "microPrecision": { - "type": "number", - "format": "float", - "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive." - }, - "microRecall": { - "type": "number", - "format": "float", - "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive." - }, - "macroF1": { - "type": "number", - "format": "float", - "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." - }, - "macroPrecision": { - "type": "number", - "format": "float", - "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive." - }, - "macroRecall": { - "type": "number", - "format": "float", - "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive." - } - }, - "required": [ - "confusionMatrix", - "entities", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ] - }, - "AnalyzeConversationAuthoringEntityEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation result for an entity.", - "properties": { - "f1": { - "type": "number", - "format": "double", - "description": "Represents the model F1 score" - }, - "precision": { - "type": "number", - "format": "double", - "description": "Represents the model precision" - }, - "recall": { - "type": "number", - "format": "double", - "description": "Represents the model precision" - }, - "truePositiveCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of true positive" - }, - "trueNegativeCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of true negative" - }, - "falsePositiveCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of false positive" - }, - "falseNegativeCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of false negative" - } - }, - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ] - }, - "AnalyzeConversationAuthoringEvaluationJobResult": { - "type": "object", - "properties": { - "evaluationOptions": { - "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationOptions", - "description": "Represents the options used running the evaluation." - }, - "modelLabel": { - "type": "string", - "description": "Represents trained model label." - }, - "trainingConfigVersion": { - "type": "string", - "description": "Represents training config version." - }, - "percentComplete": { - "type": "integer", - "format": "int32", - "description": "Represents progress percentage." - } - }, - "required": [ - "evaluationOptions", - "modelLabel", - "trainingConfigVersion", - "percentComplete" - ] - }, - "AnalyzeConversationAuthoringEvaluationJobState": { - "type": "object", - "description": "Represents the state of a evaluation job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "result": { - "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationJobResult", - "description": "Represents evaluation task detailed result." - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status", - "result" - ] - }, - "AnalyzeConversationAuthoringEvaluationOptions": { - "type": "object", - "description": "Represents the options used running the evaluation.", - "properties": { - "kind": { - "$ref": "#/definitions/EvaluationKind", - "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage." - }, - "trainingSplitPercentage": { - "type": "integer", - "format": "int32", - "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage." - }, - "testingSplitPercentage": { - "type": "integer", - "format": "int32", - "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage." - } - } - }, - "AnalyzeConversationAuthoringEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation result summary.", - "properties": { - "entitiesEvaluation": { - "$ref": "#/definitions/AnalyzeConversationAuthoringEntitiesEvaluationSummary", - "description": "Contains the data related to entities evaluation." - }, - "intentsEvaluation": { - "$ref": "#/definitions/AnalyzeConversationAuthoringIntentsEvaluationSummary", - "description": "Contains the data related to intents evaluation." - }, - "evaluationOptions": { - "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationOptions", - "description": "The options that were used while running the evaluation." - } - }, - "required": [ - "entitiesEvaluation", - "intentsEvaluation" - ] - }, - "AnalyzeConversationAuthoringExportProjectJobState": { - "type": "object", - "description": "Represents the state of an export job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "resultUrl": { - "type": "string", - "description": "The URL to use in order to download the exported project." - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "AnalyzeConversationAuthoringExportedConversationOrchestration": { - "type": "object", - "description": "Defines the orchestration details for a Conversational project target.", - "properties": { - "projectName": { - "type": "string", - "description": "The name of the targeted project." - }, - "deploymentName": { - "type": "string", - "description": "The name of the targeted deployment." - } - }, - "required": [ - "projectName", - "deploymentName" - ] - }, - "AnalyzeConversationAuthoringExportedConversationOrchestrationOptions": { - "type": "object", - "description": "Represents the orchestration options for a Conversational project target.", - "properties": { - "conversationOrchestration": { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedConversationOrchestration", - "description": "The Conversational project target details." - } - }, - "required": [ - "conversationOrchestration" - ], - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedOrchestrationOptions" - } - ], - "x-ms-discriminator-value": "Conversation" - }, - "AnalyzeConversationAuthoringExportedEntityList": { - "type": "object", - "description": "Represents a list component of an entity.", - "properties": { - "sublists": { - "type": "array", - "description": "The sub-lists of the list component.", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntitySublist" - } - } - } - }, - "AnalyzeConversationAuthoringExportedEntityListSynonym": { - "type": "object", - "description": "Represents a list of synonyms inside a list component", - "properties": { - "language": { - "type": "string", - "description": "Represents the language of the synonyms. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - }, - "values": { - "type": "array", - "description": "The list of synonyms.", - "items": { - "type": "string" - } - } - } - }, - "AnalyzeConversationAuthoringExportedEntityRegex": { - "type": "object", - "description": "Represents a regex component of an entity.", - "properties": { - "expressions": { - "type": "array", - "description": "The regex expressions of the regex component. These expressions follow the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntityRegexExpression" - } - } - } - }, - "AnalyzeConversationAuthoringExportedEntityRegexExpression": { - "type": "object", - "description": "Represents a regex expression inside a regex component. This expression follows the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", - "properties": { - "regexKey": { - "type": "string", - "description": "The key of the regex expression." - }, - "language": { - "type": "string", - "description": "Represents the language of the regex expression. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - }, - "regexPattern": { - "type": "string", - "description": "The regex pattern." - } - } - }, - "AnalyzeConversationAuthoringExportedEntitySublist": { - "type": "object", - "description": "Represents a sub-list inside a list component.", - "properties": { - "listKey": { - "type": "string", - "description": "The key of the sub-list." - }, - "synonyms": { - "type": "array", - "description": "The phrases of that correspond to the sub-list.", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntityListSynonym" - } - } - } - }, - "AnalyzeConversationAuthoringExportedLuisOrchestration": { - "type": "object", - "description": "Defines the orchestration details for a LUIS application target.", - "properties": { - "appId": { - "$ref": "#/definitions/Azure.Core.uuid", - "description": "The LUIS application ID." - }, - "appVersion": { - "type": "string", - "description": "The targeted version Id." - }, - "slotName": { - "type": "string", - "description": "The targeted slot name." - } - }, - "required": [ - "appId" - ] - }, - "AnalyzeConversationAuthoringExportedLuisOrchestrationOptions": { - "type": "object", - "description": "Represents the orchestration options for a LUIS application target.", - "properties": { - "luisOrchestration": { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedLuisOrchestration", - "description": "The LUIS application target details." - } - }, - "required": [ - "luisOrchestration" - ], - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedOrchestrationOptions" - } - ], - "x-ms-discriminator-value": "Luis" - }, - "AnalyzeConversationAuthoringExportedOrchestrationOptions": { - "type": "object", - "description": "Represents the options used to define the orchestration behavior of an intent.", - "properties": { - "targetProjectKind": { - "$ref": "#/definitions/OrchestrationTargetProjectKind" - } - }, - "discriminator": "targetProjectKind", - "required": [ - "targetProjectKind" - ] - }, - "AnalyzeConversationAuthoringExportedPrebuiltEntity": { - "type": "object", - "description": "Represents an exported prebuilt entity component", - "properties": { - "category": { - "type": "string", - "description": "The prebuilt entity category." - } - }, - "required": [ - "category" - ] - }, - "AnalyzeConversationAuthoringExportedProject": { - "type": "object", - "description": "Represents an exported project.", - "properties": { - "projectFileVersion": { - "type": "string", - "description": "The version of the exported file." - }, - "stringIndexType": { - "$ref": "#/definitions/StringIndexType", - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets." - }, - "metadata": { - "$ref": "#/definitions/AnalyzeConversationAuthoringCreateProjectOptions", - "description": "Represents the project metadata." - }, - "assets": { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedProjectAssets", - "description": "Represents the project assets." - } - }, - "required": [ - "projectFileVersion", - "stringIndexType", - "metadata" - ] - }, - "AnalyzeConversationAuthoringExportedProjectAssets": { - "type": "object", - "description": "Represents the assets of an exported project.", - "properties": { - "projectKind": { - "$ref": "#/definitions/ProjectKind", - "description": "The type of project containing the assets." - } - }, - "discriminator": "projectKind", - "required": [ - "projectKind" - ] - }, - "AnalyzeConversationAuthoringExportedQuestionAnsweringOrchestration": { - "type": "object", - "description": "Defines the orchestration details for a Question Answering project target.", - "properties": { - "projectName": { - "type": "string", - "description": "The name of the target project." - } - }, - "required": [ - "projectName" - ] - }, - "AnalyzeConversationAuthoringExportedQuestionAnsweringOrchestrationOptions": { - "type": "object", - "description": "Represents the orchestration options for a Question Answering project target.", - "properties": { - "questionAnsweringOrchestration": { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedQuestionAnsweringOrchestration", - "description": "The Question Answering project details." - } - }, - "required": [ - "questionAnsweringOrchestration" - ], - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedOrchestrationOptions" - } - ], - "x-ms-discriminator-value": "QuestionAnswering" - }, - "AnalyzeConversationAuthoringExportedUtteranceEntityLabel": { - "type": "object", - "description": "Represents an entity label for an utterance.", - "properties": { - "category": { - "type": "string", - "description": "The category of the entity label." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text." - } - }, - "required": [ - "category", - "offset", - "length" - ] - }, - "AnalyzeConversationAuthoringImportProjectJobState": { - "type": "object", - "description": "Represents the state of an import job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "AnalyzeConversationAuthoringIntentEvaluationSummary": { - "type": "object", - "description": "The evaluation summary for an intent.", - "properties": { - "f1": { - "type": "number", - "format": "double", - "description": "Represents the model precision" - }, - "precision": { - "type": "number", - "format": "double", - "description": "Represents the model recall" - }, - "recall": { - "type": "number", - "format": "double", - "description": "Represents the model F1 score" - }, - "truePositiveCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of true positive" - }, - "trueNegativeCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of true negative" - }, - "falsePositiveCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of false positive" - }, - "falseNegativeCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of false negative" - } - }, - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ] - }, - "AnalyzeConversationAuthoringIntentsEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation summary for the project's intents.", - "properties": { - "confusionMatrix": { - "type": "object", - "description": "Represents the confusion matrix between two intents (the two intents can be the same). The matrix is between the intent that was labelled and the intent that was predicted.", - "additionalProperties": { - "$ref": "#/definitions/AnalyzeConversationAuthoringConfusionMatrixRow" - } - }, - "intents": { - "type": "object", - "description": "Represents the intents evaluation summary.", - "additionalProperties": { - "$ref": "#/definitions/AnalyzeConversationAuthoringIntentEvaluationSummary" - } - }, - "microF1": { - "type": "number", - "format": "float", - "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." - }, - "microPrecision": { - "type": "number", - "format": "float", - "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive." - }, - "microRecall": { - "type": "number", - "format": "float", - "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive." - }, - "macroF1": { - "type": "number", - "format": "float", - "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." - }, - "macroPrecision": { - "type": "number", - "format": "float", - "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive." - }, - "macroRecall": { - "type": "number", - "format": "float", - "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive." - } - }, - "required": [ - "confusionMatrix", - "intents", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ] - }, - "AnalyzeConversationAuthoringLoadSnapshotJobState": { - "type": "object", - "description": "Represents the state of loading a snapshot job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "AnalyzeConversationAuthoringOrchestrationExportedIntent": { - "type": "object", - "description": "Represents an exported intent for an orchestration project.", - "properties": { - "orchestration": { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedOrchestrationOptions", - "description": "Specifies the behavior of this intent in the orchestration flow." - }, - "category": { - "type": "string", - "description": "The intent category." - } - }, - "required": [ - "category" - ] - }, - "AnalyzeConversationAuthoringOrchestrationExportedProjectAsset": { - "type": "object", - "description": "Represents the assets of an orchestration project.", - "properties": { - "intents": { - "type": "array", - "description": "Represents the intents of the project.", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringOrchestrationExportedIntent" - } - }, - "utterances": { - "type": "array", - "description": "Represents the utterances of the project.", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringOrchestrationExportedUtterance" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationAuthoringExportedProjectAssets" - } - ], - "x-ms-discriminator-value": "Orchestration" - }, - "AnalyzeConversationAuthoringOrchestrationExportedUtterance": { - "type": "object", - "description": "Represents an utterance of an orchestration project.", - "properties": { - "text": { - "type": "string", - "description": "The utterance text." - }, - "language": { - "type": "string", - "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - }, - "intent": { - "type": "string", - "description": "The intent of the utterance." - }, - "dataset": { - "type": "string", - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'." - } - }, - "required": [ - "text", - "intent" - ] - }, - "AnalyzeConversationAuthoringPrebuiltEntity": { - "type": "object", - "description": "Represents a supported prebuilt entity.", - "properties": { - "category": { - "type": "string", - "description": "The prebuilt entity category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description." - }, - "examples": { - "type": "string", - "description": "English examples for the entity." - } - }, - "required": [ - "category", - "description", - "examples" - ] - }, - "AnalyzeConversationAuthoringProjectDeletionJobState": { - "type": "object", - "description": "Represents the state of a project deletion job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "AnalyzeConversationAuthoringProjectDeployment": { - "type": "object", - "description": "Represents a project deployment.", - "properties": { - "deploymentName": { - "type": "string", - "description": "Represents deployment name.", - "readOnly": true - }, - "modelId": { - "type": "string", - "description": "Represents deployment modelId." - }, - "lastTrainedDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents deployment last trained time." - }, - "lastDeployedDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents deployment last deployed time." - }, - "deploymentExpirationDate": { - "type": "string", - "format": "date", - "description": "Represents deployment expiration date in the runtime." - }, - "modelTrainingConfigVersion": { - "type": "string", - "description": "Represents model training config version." - }, - "assignedResources": { - "type": "array", - "description": "Represents the metadata of the assigned Azure resources.", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentResource" - } - } - }, - "required": [ - "deploymentName", - "modelId", - "lastTrainedDateTime", - "lastDeployedDateTime", - "deploymentExpirationDate", - "modelTrainingConfigVersion", - "assignedResources" - ] - }, - "AnalyzeConversationAuthoringProjectMetadata": { - "type": "object", - "description": "Represents the metadata of a project.", - "properties": { - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents the project creation datetime." - }, - "lastModifiedDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents the project creation datetime." - }, - "lastTrainedDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents the project last trained datetime." - }, - "lastDeployedDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents the project last deployed datetime." - }, - "projectKind": { - "$ref": "#/definitions/ProjectKind", - "description": "Represents the project kind.", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "settings": { - "$ref": "#/definitions/AnalyzeConversationAuthoringProjectSettings", - "description": "The project settings.", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "storageInputContainerName": { - "type": "string", - "description": "The storage container name in case of conversation summarization.", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "projectName": { - "type": "string", - "description": "The new project name.", - "maxLength": 100, - "x-ms-mutability": [ - "read", - "create" - ] - }, - "multilingual": { - "type": "boolean", - "description": "Whether the project would be used for multiple languages or not.", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "description": { - "type": "string", - "description": "The project description.", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "language": { - "type": "string", - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "required": [ - "createdDateTime", - "lastModifiedDateTime", - "projectKind", - "projectName", - "language" - ] - }, - "AnalyzeConversationAuthoringProjectSettings": { - "type": "object", - "description": "Represents the settings used to define the project behavior.", - "properties": { - "confidenceThreshold": { - "type": "number", - "format": "float", - "description": "The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive." - } - }, - "required": [ - "confidenceThreshold" - ] - }, - "AnalyzeConversationAuthoringProjectTrainedModel": { - "type": "object", - "description": "Represents a trained model.", - "properties": { - "label": { - "type": "string", - "description": "The trained model label.", - "readOnly": true - }, - "modelId": { - "type": "string", - "description": "The model ID." - }, - "lastTrainedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last trained date time of the model." - }, - "lastTrainingDurationInSeconds": { - "type": "integer", - "format": "int32", - "description": "The duration of the model's last training request in seconds." - }, - "modelExpirationDate": { - "type": "string", - "format": "date", - "description": "The model expiration date." - }, - "modelTrainingConfigVersion": { - "type": "string", - "description": "The model training config version." - }, - "hasSnapshot": { - "type": "boolean", - "description": "The flag to indicate if the trained model has a snapshot ready." - } - }, - "required": [ - "label", - "modelId", - "lastTrainedDateTime", - "lastTrainingDurationInSeconds", - "modelExpirationDate", - "modelTrainingConfigVersion", - "hasSnapshot" - ] - }, - "AnalyzeConversationAuthoringResourceMetadata": { - "type": "object", - "description": "Represents metadata for the Azure resource..", - "properties": { - "azureResourceId": { - "type": "string", - "description": "Represents the Azure resource ID." - }, - "customDomain": { - "type": "string", - "description": "Represents the Azure resource custom domain." - }, - "region": { - "type": "string", - "description": "Represents the Azure resource region." - } - }, - "required": [ - "azureResourceId", - "customDomain", - "region" - ] - }, - "AnalyzeConversationAuthoringSubTrainingJobState": { - "type": "object", - "description": "Represents the detailed state of a training sub-operation.", - "properties": { - "percentComplete": { - "type": "integer", - "format": "int32", - "description": "Represents progress percentage." - }, - "startDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents the start date time." - }, - "endDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents the end date time." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "Represents the status of the sub-operation." - } - }, - "required": [ - "percentComplete", - "status" - ] - }, - "AnalyzeConversationAuthoringSupportedLanguage": { - "type": "object", - "description": "Represents a supported language.", - "properties": { - "languageName": { - "type": "string", - "description": "The language name.", - "readOnly": true - }, - "languageCode": { - "type": "string", - "description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - } - }, - "required": [ - "languageName", - "languageCode" - ] - }, - "AnalyzeConversationAuthoringSwapDeploymentsJobState": { - "type": "object", - "description": "Represents the state of a deployment job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "AnalyzeConversationAuthoringSwapDeploymentsOptions": { - "type": "object", - "description": "Represents the options for swapping two deployments together.", - "properties": { - "firstDeploymentName": { - "type": "string", - "description": "Represents the first deployment name." - }, - "secondDeploymentName": { - "type": "string", - "description": "Represents the second deployment name." - } - }, - "required": [ - "firstDeploymentName", - "secondDeploymentName" - ] - }, - "AnalyzeConversationAuthoringTrainingConfigVersion": { - "type": "object", - "description": "Represents a training config version.", - "properties": { - "trainingConfigVersion": { - "type": "string", - "description": "Represents the version of the config.", - "readOnly": true - }, - "modelExpirationDate": { - "type": "string", - "format": "date", - "description": "Represents the training config version expiration date." - } - }, - "required": [ - "trainingConfigVersion", - "modelExpirationDate" - ] - }, - "AnalyzeConversationAuthoringTrainingJobOptions": { - "type": "object", - "description": "Represents the options for starting a new training job.", - "properties": { - "modelLabel": { - "type": "string", - "description": "Represents the output model label." - }, - "trainingConfigVersion": { - "type": "string", - "description": "Represents training config version. By default, \"latest\" value is used which uses the latest released training config version." - }, - "trainingMode": { - "$ref": "#/definitions/TrainingMode", - "description": "Represents the mode of the training operation." - }, - "evaluationOptions": { - "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationOptions", - "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20." - } - }, - "required": [ - "modelLabel", - "trainingMode" - ] - }, - "AnalyzeConversationAuthoringTrainingJobResult": { - "type": "object", - "description": "Represents the output of a training job.", - "properties": { - "modelLabel": { - "type": "string", - "description": "Represents trained model label." - }, - "trainingConfigVersion": { - "type": "string", - "description": "Represents training config version." - }, - "trainingMode": { - "$ref": "#/definitions/TrainingMode", - "description": "Represents the mode of the training operation." - }, - "trainingStatus": { - "$ref": "#/definitions/AnalyzeConversationAuthoringSubTrainingJobState", - "description": "Represents the model training status." - }, - "evaluationStatus": { - "$ref": "#/definitions/AnalyzeConversationAuthoringSubTrainingJobState", - "description": "Represents model evaluation status." - }, - "estimatedEndDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents the estimated end date time for training and evaluation." - } - }, - "required": [ - "modelLabel", - "trainingConfigVersion", - "trainingStatus" - ] - }, - "AnalyzeConversationAuthoringTrainingJobState": { - "type": "object", - "description": "Represents the state of a training job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "result": { - "$ref": "#/definitions/AnalyzeConversationAuthoringTrainingJobResult", - "description": "Represents training tasks detailed result." - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status", - "result" - ] - }, - "AnalyzeConversationAuthoringUnassignDeploymentResourcesOptions": { - "type": "object", - "description": "Represents the options to unassign Azure resources from a project.", - "properties": { - "assignedResourceIds": { - "type": "array", - "description": "Represents the assigned resource IDs to be unassigned.", - "items": { - "type": "string" - } - } - }, - "required": [ - "assignedResourceIds" - ] - }, - "AnalyzeConversationAuthoringUtteranceEntitiesEvaluationResult": { - "type": "object", - "description": "Represents the comparison between the expected and predicted entities for an utterance.", - "properties": { - "expectedEntities": { - "type": "array", - "description": "Represents the expected entity labels.", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceEntityEvaluationResult" - } - }, - "predictedEntities": { - "type": "array", - "description": "Represents the predicted entity labels.", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceEntityEvaluationResult" - } - } - }, - "required": [ - "expectedEntities", - "predictedEntities" - ] - }, - "AnalyzeConversationAuthoringUtteranceEntityEvaluationResult": { - "type": "object", - "description": "Represents the evaluation output of an entity label or prediction.", - "properties": { - "category": { - "type": "string", - "description": "Represents the entity category." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Represents the entity offset index relative to the original text." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Represents the entity length." - } - }, - "required": [ - "category", - "offset", - "length" - ] - }, - "AnalyzeConversationAuthoringUtteranceEvaluationResult": { - "type": "object", - "description": "Represents the evaluation result for an utterance.", - "properties": { - "text": { - "type": "string", - "description": "Represents the utterance text.", - "readOnly": true - }, - "language": { - "type": "string", - "description": "Represents the utterance language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - }, - "entitiesResult": { - "$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceEntitiesEvaluationResult", - "description": "Represents the entities results for the utterance." - }, - "intentsResult": { - "$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceIntentsEvaluationResult", - "description": "Represents the intents results for the utterance." - } - }, - "required": [ - "text", - "language", - "entitiesResult", - "intentsResult" - ] - }, - "AnalyzeConversationAuthoringUtteranceIntentsEvaluationResult": { - "type": "object", - "description": "Represents the comparison between the expected and the predicted intent for an utterance.", - "properties": { - "expectedIntent": { - "type": "string", - "description": "Represents the utterance's expected intent." - }, - "predictedIntent": { - "type": "string", - "description": "Represents the utterance's predicted intent." - } - }, - "required": [ - "expectedIntent", - "predictedIntent" - ] - }, - "Azure.Core.Foundations.Error": { - "type": "object", - "description": "The error object.", - "properties": { - "code": { - "type": "string", - "description": "One of a server-defined set of error codes." - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - }, - "target": { - "type": "string", - "description": "The target of the error." - }, - "details": { - "type": "array", - "description": "An array of details about specific errors that led to this reported error.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "innererror": { - "$ref": "#/definitions/Azure.Core.Foundations.InnerError", - "description": "An object containing more specific information than the current object about the error." - } - }, - "required": [ - "code", - "message" - ] - }, - "Azure.Core.Foundations.ErrorResponse": { - "type": "object", - "description": "A response containing error details.", - "properties": { - "error": { - "$ref": "#/definitions/Azure.Core.Foundations.Error", - "description": "The error object." - } - }, - "required": [ - "error" - ] - }, - "Azure.Core.Foundations.InnerError": { - "type": "object", - "description": "An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.", - "properties": { - "code": { - "type": "string", - "description": "One of a server-defined set of error codes." - }, - "innererror": { - "$ref": "#/definitions/Azure.Core.Foundations.InnerError", - "description": "Inner error." - } - } - }, - "Azure.Core.uuid": { - "type": "string", - "format": "uuid", - "description": "Universally Unique Identifier" - }, - "CompositionSetting": { - "type": "string", - "enum": [ - "returnLongestOverlap", - "requireExactOverlap", - "separateComponents", - "combineComponents" - ], - "x-ms-enum": { - "name": "CompositionSetting", - "modelAsString": true, - "values": [ - { - "name": "returnLongestOverlap", - "value": "returnLongestOverlap", - "description": "When two or more components are found in the text and overlap, the component with the longest set of characters is returned." - }, - { - "name": "requireExactOverlap", - "value": "requireExactOverlap", - "description": "All components must overlap at the exact same characters in the text for the entity to return. If one of the defined components is not matched or predicted, the entity will not return." - }, - { - "name": "separateComponents", - "value": "separateComponents", - "description": "Every component's match or prediction is returned as a separate instance of the entity." - }, - { - "name": "combineComponents", - "value": "combineComponents", - "description": "When two or more components are found in the text and overlap, the components' spans are merged together into one span combining all of them." - } - ] - } - }, - "DatasetType": { - "type": "string", - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", - "enum": [ - "Train", - "Test" - ], - "x-ms-enum": { - "name": "DatasetType", - "modelAsString": true, - "values": [ - { - "name": "Train", - "value": "Train", - "description": "Split the data into training and test sets according to user-defined percentages." - }, - { - "name": "Test", - "value": "Test", - "description": "Split the data according to the chosen dataset for every example in the data." - } - ] - } - }, - "EvaluationKind": { - "type": "string", - "enum": [ - "percentage", - "manual" - ], - "x-ms-enum": { - "name": "EvaluationKind", - "modelAsString": true, - "values": [ - { - "name": "percentage", - "value": "percentage", - "description": "Split the data into training and test sets according to user-defined percentages." - }, - { - "name": "manual", - "value": "manual", - "description": "Split the data according to the chosen dataset for every example in the data." - } - ] - } - }, - "JobStatus": { - "type": "string", - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling", - "partiallyCompleted" - ], - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true, - "values": [ - { - "name": "notStarted", - "value": "notStarted" - }, - { - "name": "running", - "value": "running" - }, - { - "name": "succeeded", - "value": "succeeded" - }, - { - "name": "failed", - "value": "failed" - }, - { - "name": "cancelled", - "value": "cancelled" - }, - { - "name": "cancelling", - "value": "cancelling" - }, - { - "name": "partiallyCompleted", - "value": "partiallyCompleted" - } - ] - } - }, - "OrchestrationTargetProjectKind": { - "type": "string", - "enum": [ - "Luis", - "Conversation", - "QuestionAnswering" - ], - "x-ms-enum": { - "name": "OrchestrationTargetProjectKind", - "modelAsString": true, - "values": [ - { - "name": "Luis", - "value": "Luis" - }, - { - "name": "Conversation", - "value": "Conversation" - }, - { - "name": "QuestionAnswering", - "value": "QuestionAnswering" - } - ] - } - }, - "PagedAnalyzeConversationAuthoringAssignedDeploymentResource": { - "type": "object", - "description": "Paged collection of AnalyzeConversationAuthoringAssignedDeploymentResource items", - "properties": { - "value": { - "type": "array", - "description": "The AnalyzeConversationAuthoringAssignedDeploymentResource items on this page", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringAssignedDeploymentResource" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedAnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata": { - "type": "object", - "description": "Paged collection of AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata items", - "properties": { - "value": { - "type": "array", - "description": "The AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata items on this page", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedAnalyzeConversationAuthoringPrebuiltEntity": { - "type": "object", - "description": "Paged collection of AnalyzeConversationAuthoringPrebuiltEntity items", - "properties": { - "value": { - "type": "array", - "description": "The AnalyzeConversationAuthoringPrebuiltEntity items on this page", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringPrebuiltEntity" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedAnalyzeConversationAuthoringProjectDeployment": { - "type": "object", - "description": "Paged collection of AnalyzeConversationAuthoringProjectDeployment items", - "properties": { - "value": { - "type": "array", - "description": "The AnalyzeConversationAuthoringProjectDeployment items on this page", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringProjectDeployment" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedAnalyzeConversationAuthoringProjectMetadata": { - "type": "object", - "description": "Paged collection of AnalyzeConversationAuthoringProjectMetadata items", - "properties": { - "value": { - "type": "array", - "description": "The AnalyzeConversationAuthoringProjectMetadata items on this page", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringProjectMetadata" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedAnalyzeConversationAuthoringProjectTrainedModel": { - "type": "object", - "description": "Paged collection of AnalyzeConversationAuthoringProjectTrainedModel items", - "properties": { - "value": { - "type": "array", - "description": "The AnalyzeConversationAuthoringProjectTrainedModel items on this page", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringProjectTrainedModel" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedAnalyzeConversationAuthoringSupportedLanguage": { - "type": "object", - "description": "Paged collection of AnalyzeConversationAuthoringSupportedLanguage items", - "properties": { - "value": { - "type": "array", - "description": "The AnalyzeConversationAuthoringSupportedLanguage items on this page", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringSupportedLanguage" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedAnalyzeConversationAuthoringTrainingConfigVersion": { - "type": "object", - "description": "Paged collection of AnalyzeConversationAuthoringTrainingConfigVersion items", - "properties": { - "value": { - "type": "array", - "description": "The AnalyzeConversationAuthoringTrainingConfigVersion items on this page", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringTrainingConfigVersion" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedAnalyzeConversationAuthoringTrainingJobState": { - "type": "object", - "description": "Paged collection of AnalyzeConversationAuthoringTrainingJobState items", - "properties": { - "value": { - "type": "array", - "description": "The AnalyzeConversationAuthoringTrainingJobState items on this page", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringTrainingJobState" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedAnalyzeConversationAuthoringUtteranceEvaluationResult": { - "type": "object", - "description": "Paged collection of AnalyzeConversationAuthoringUtteranceEvaluationResult items", - "properties": { - "value": { - "type": "array", - "description": "The AnalyzeConversationAuthoringUtteranceEvaluationResult items on this page", - "items": { - "$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceEvaluationResult" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "ProjectKind": { - "type": "string", - "enum": [ - "Conversation", - "Orchestration", - "CustomConversationSummarization" - ], - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "name": "Conversation", - "value": "Conversation", - "description": "A project to build natural language into apps, bots, and IoT devices." - }, - { - "name": "Orchestration", - "value": "Orchestration", - "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." - }, - { - "name": "CustomConversationSummarization", - "value": "CustomConversationSummarization", - "description": "A project to build conversation summarization models which are able to summarize long conversations." - } - ] - } - }, - "StringIndexType": { - "type": "string", - "enum": [ - "Utf16CodeUnit", - "Utf8CodeUnit", - "Utf32CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "name": "Utf16CodeUnit", - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - }, - { - "name": "Utf8CodeUnit", - "value": "Utf8CodeUnit" - }, - { - "name": "Utf32CodeUnit", - "value": "Utf32CodeUnit" - } - ] - } - }, - "TrainingMode": { - "type": "string", - "enum": [ - "advanced", - "standard" - ], - "x-ms-enum": { - "name": "TrainingMode", - "modelAsString": true, - "values": [ - { - "name": "advanced", - "value": "advanced", - "description": "Trains using fine-tuned neural network transformer models. Can train multilingual projects." - }, - { - "name": "standard", - "value": "standard", - "description": "Faster training times for quicker iterations." - } - ] - } - } - }, - "parameters": { - "Azure.Core.Foundations.ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for this operation.", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "x-ms-client-name": "apiVersion" - }, - "Azure.Core.MaxPageSizeQueryParameter": { - "name": "maxpagesize", - "in": "query", - "description": "The maximum number of result items per page.", - "required": false, - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "Azure.Core.SkipQueryParameter": { - "name": "skip", - "in": "query", - "description": "The number of result items to skip.", - "required": false, - "type": "integer", - "format": "int32", - "default": 0, - "x-ms-parameter-location": "method" - }, - "Azure.Core.TopQueryParameter": { - "name": "top", - "in": "query", - "description": "The number of result items to return.", - "required": false, - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "ProjectKindQueryParameter": { - "name": "projectKind", - "in": "query", - "description": "The project kind.", - "required": true, - "type": "string", - "enum": [ - "Conversation", - "Orchestration", - "CustomConversationSummarization" - ], - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "name": "Conversation", - "value": "Conversation", - "description": "A project to build natural language into apps, bots, and IoT devices." - }, - { - "name": "Orchestration", - "value": "Orchestration", - "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." - }, - { - "name": "CustomConversationSummarization", - "value": "CustomConversationSummarization", - "description": "A project to build conversation summarization models which are able to summarize long conversations." - } - ] - }, - "x-ms-parameter-location": "method", - "x-ms-client-name": "ProjectKind" - }, - "StringIndexTypeQueryParameter": { - "name": "stringIndexType", - "in": "query", - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "required": true, - "type": "string", - "enum": [ - "Utf16CodeUnit", - "Utf8CodeUnit", - "Utf32CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "name": "Utf16CodeUnit", - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - }, - { - "name": "Utf8CodeUnit", - "value": "Utf8CodeUnit" - }, - { - "name": "Utf32CodeUnit", - "value": "Utf32CodeUnit" - } - ] - }, - "x-ms-parameter-location": "method" - }, - "SupportedPrebuiltEntitiesQueryParameter.language": { - "name": "language", - "in": "query", - "description": "The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SupportedPrebuiltEntitiesQueryParameter.multilingual": { - "name": "multilingual", - "in": "query", - "description": "Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations.json deleted file mode 100644 index a436ceceead1..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations.json +++ /dev/null @@ -1,2672 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Analyze Conversations", - "description": "The language service conversations API is a suite of natural language processing (NLP) skills that can be used to analyze structured conversations (textual or spoken). The synchronous API in this suite accepts a request and mediates among multiple language projects, such as LUIS Generally Available, Question Answering, Conversational Language Understanding, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload.\n\n In some cases, this API needs to forward requests and responses between the caller and an upstream service. The asynchronous APIs in this suite enable tasks like Conversation Summarization and Conversational PII detection.", - "version": "2023-04-15-preview" - }, - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" - } - }, - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://cognitiveservices.azure.com/.default" - ] - }, - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/:analyze-conversations": { - "post": { - "operationId": "ConversationAnalysis_AnalyzeConversation", - "description": "Analyzes the input conversation utterance.", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "A single conversational task to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeConversationTask" - }, - "required": true - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The conversation analysis response.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationTaskResult" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" - } - } - } - }, - "x-ms-examples": { - "Conversation project result": { - "$ref": "./examples/conversations/SuccessfulAnalyzeConversations.json" - }, - "Arbitration result": { - "$ref": "./examples/conversations/SuccessfulAnalyzeConversationsArbitration.json" - }, - "Orchestrator direct target result": { - "$ref": "./examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json" - } - } - } - }, - "/analyze-conversations/jobs": { - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "description": "Submit a collection of conversations for analysis. Specify one or more unique tasks to be executed.", - "operationId": "AnalyzeConversation_SubmitJob", - "summary": "Submit analysis job for conversations", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "The collection of conversations to analyze and one or more tasks to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeConversationJobsInput" - }, - "required": true - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Conversational PII Analysis Job Request": { - "$ref": "./examples/conversations/SuccessfulConversationPIISubmit.json" - }, - "Successful Conversational PII Analysis Exclusion Job Request": { - "$ref": "./examples/conversations/SuccessfulConversationPIIExclusionSubmit.json" - }, - "Successful Conversational PII Analysis Redaction Job Request": { - "$ref": "./examples/conversations/SuccessfulConversationPIIRedactionCharSubmit.json" - }, - "Successful Conversation Summarization Analysis Job Request": { - "$ref": "./examples/conversations/SuccessfulConversationSummarySubmit.json" - }, - "Successful Conversation Summarization Task Submit": { - "$ref": "./examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json" - }, - "Successful Custom Conversation Summarization Task Submit": { - "$ref": "./examples/conversations/SuccessfulCustomConversationSummarizationTaskSubmit.json" - }, - "Successful Conversation Sentiment Analysis Job Request": { - "$ref": "./examples/conversations/SuccessfulConversationSentimentSubmit.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/analyze-conversations/jobs/{jobId}": { - "get": { - "produces": [ - "application/json" - ], - "description": "Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are succeeded, the job will transition to the succeeded state and results will be available for each task.", - "operationId": "AnalyzeConversation_JobStatus", - "summary": "Get analysis status and results", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/JobId" - }, - { - "$ref": "common.json#/parameters/ShowStats" - } - ], - "responses": { - "200": { - "description": "Analysis job status and metadata.", - "schema": { - "$ref": "#/definitions/AnalyzeConversationJobState" - } - }, - "default": { - "description": "Error encountered.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Conversation PII Analysis Job Status Request": { - "$ref": "./examples/conversations/SuccessfulConversationPIITaskStatusRequest.json" - }, - "Successful Get Text Conversation Analysis Exclusion Job Status Request": { - "$ref": "./examples/conversations/SuccessfulConversationPIIExclusionTaskStatusRequest.json" - }, - "Successful Get Text Conversation Analysis Redaction Job Status Request": { - "$ref": "./examples/conversations/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json" - }, - "Successful Get Text Conversation Analysis Job Status Request": { - "$ref": "./examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json" - }, - "Successful Get Conversation Sentiment Analysis Job Status Request": { - "$ref": "./examples/conversations/SuccessfulConversationSentimentTaskStatusRequest.json" - }, - "Successful Get Conversation Summarization Result": { - "$ref": "./examples/conversations/SuccessfulConversationSummarizationTaskResult.json" - }, - "Successful Get Custom Conversation Summarization Result": { - "$ref": "./examples/conversations/SuccessfulCustomConversationSummarizationTaskResult.json" - } - } - } - }, - "/analyze-conversations/jobs/{jobId}:cancel": { - "post": { - "produces": [ - "application/json" - ], - "description": "Cancel a long-running Text Analysis conversations job.", - "operationId": "AnalyzeConversation_CancelJob", - "summary": "Cancel a long-running Text Analysis conversations job", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/JobId" - } - ], - "responses": { - "202": { - "description": "Cancel Job request has been received.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Job Delete Request": { - "$ref": "./examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json" - } - }, - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "AnalyzeConversationTaskKind": { - "type": "string", - "description": "Enumeration of supported Conversation tasks.", - "enum": [ - "Conversation" - ], - "x-ms-enum": { - "name": "AnalyzeConversationTaskKind", - "modelAsString": true - } - }, - "AnalyzeConversationTaskResultsKind": { - "type": "string", - "description": "Enumeration of supported conversational task results", - "enum": [ - "ConversationResult" - ], - "x-ms-enum": { - "name": "AnalyzeConversationTaskResultsKind", - "modelAsString": true - } - }, - "AnalyzeConversationTask": { - "type": "object", - "description": "The base class of a conversation input task.", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationTaskKind" - } - } - }, - "AnalyzeConversationTaskResult": { - "type": "object", - "description": "The base class of a conversation task result.", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationTaskResultsKind" - } - } - }, - "ConversationalTask": { - "type": "object", - "description": "The input for a custom conversation task.", - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationTask" - } - ], - "properties": { - "analysisInput": { - "$ref": "#/definitions/ConversationAnalysisOptions" - }, - "parameters": { - "$ref": "#/definitions/ConversationTaskParameters" - } - }, - "x-ms-discriminator-value": "Conversation", - "required": [ - "analysisInput", - "parameters" - ] - }, - "ConversationTaskParameters": { - "type": "object", - "description": "Input parameters necessary for a Conversation task.", - "properties": { - "projectName": { - "type": "string", - "description": "The name of the project to use." - }, - "deploymentName": { - "type": "string", - "description": "The name of the deployment to use." - }, - "verbose": { - "type": "boolean", - "description": "If true, the service will return more detailed information in the response." - }, - "isLoggingEnabled": { - "type": "boolean", - "description": "If true, the service will keep the query for further review." - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - }, - "directTarget": { - "type": "string", - "description": "The name of a target project to forward the request to." - }, - "targetProjectParameters": { - "type": "object", - "description": "A dictionary representing the parameters for each target project.", - "additionalProperties": { - "$ref": "#/definitions/AnalysisParameters" - } - } - }, - "required": [ - "projectName", - "deploymentName" - ] - }, - "ConversationalTaskResult": { - "description": "The results of a Conversation task.", - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationTaskResult" - } - ], - "type": "object", - "properties": { - "result": { - "$ref": "#/definitions/AnalyzeConversationResult" - } - }, - "required": [ - "result" - ], - "x-ms-discriminator-value": "ConversationResult" - }, - "ConversationItemBase": { - "type": "object", - "description": "The abstract base for a user input formatted conversation (e.g., Text, Transcript).", - "properties": { - "id": { - "description": "The ID of a conversation item.", - "type": "string" - }, - "participantId": { - "description": "The participant ID of a conversation item.", - "type": "string" - }, - "language": { - "description": "The override language of a conversation item in BCP 47 language representation.", - "type": "string" - }, - "modality": { - "$ref": "#/definitions/Modality" - }, - "role": { - "type": "string", - "description": "The role of the participant.", - "enum": [ - "agent", - "customer", - "generic" - ], - "x-ms-enum": { - "name": "role", - "modelAsString": true - } - } - }, - "required": [ - "participantId", - "id" - ], - "additionalProperties": true - }, - "TextConversationItem": { - "type": "object", - "description": "The text modality of an input conversation.", - "allOf": [ - { - "$ref": "#/definitions/ConversationItemBase" - } - ], - "properties": { - "text": { - "description": "The text input", - "type": "string" - } - }, - "required": [ - "text" - ] - }, - "ConversationAnalysisOptions": { - "type": "object", - "description": "The input ConversationItem and its optional parameters", - "required": [ - "conversationItem" - ], - "properties": { - "conversationItem": { - "$ref": "#/definitions/ConversationItemBase" - } - } - }, - "AnalysisParameters": { - "type": "object", - "description": "This is the parameter set of either the Orchestration project itself or one of the target services.", - "required": [ - "targetProjectKind" - ], - "discriminator": "targetProjectKind", - "properties": { - "targetProjectKind": { - "type": "string", - "description": "The type of a target service.", - "enum": [ - "Luis", - "Conversation", - "QuestionAnswering", - "NonLinked" - ], - "x-ms-enum": { - "name": "targetProjectKind", - "modelAsString": true - } - }, - "apiVersion": { - "type": "string", - "description": "The API version to use when call a specific target service." - } - } - }, - "NoneLinkedTargetIntentResult": { - "type": "object", - "description": "A wrap up of non-linked intent response.", - "x-ms-discriminator-value": "NonLinked", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "$ref": "#/definitions/ConversationResult", - "description": "The actual response from a Conversation project." - } - } - }, - "LuisParameters": { - "description": "This is a set of request parameters for LUIS Generally Available projects.", - "x-ms-discriminator-value": "Luis", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "query": { - "type": "string", - "maxLength": 500, - "description": "The utterance to predict." - }, - "callingOptions": { - "type": "object", - "description": "This customizes how the service calls LUIS Generally Available projects.", - "$ref": "#/definitions/LuisCallingOptions" - } - }, - "additionalProperties": true - }, - "LuisCallingOptions": { - "description": "This customizes how the service calls LUIS Generally Available projects.", - "type": "object", - "properties": { - "verbose": { - "description": "Enable verbose response.", - "type": "boolean" - }, - "log": { - "description": "Save log to add in training utterances later.", - "type": "boolean" - }, - "show-all-intents": { - "description": "Set true to show all intents.", - "type": "boolean" - }, - "timezoneOffset": { - "type": "number", - "description": "The timezone offset for the location of the request." - }, - "spellCheck": { - "type": "boolean", - "description": "Enable spell checking." - }, - "bing-spell-check-subscription-key": { - "description": "The subscription key to use when enabling Bing spell check", - "type": "string" - } - } - }, - "ConversationParameters": { - "type": "object", - "description": "This is a set of request parameters for Customized Conversation projects.", - "x-ms-discriminator-value": "Conversation", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "callingOptions": { - "type": "object", - "$ref": "#/definitions/ConversationCallingOptions" - } - } - }, - "ConversationCallingOptions": { - "type": "object", - "description": "The option to set to call a Conversation project.", - "properties": { - "language": { - "description": "The language of the query in BCP 47 language representation..", - "type": "string" - }, - "verbose": { - "description": "If true, the service will return more detailed information.", - "type": "boolean" - }, - "isLoggingEnabled": { - "description": "If true, the query will be saved for customers to further review in authoring, to improve the model quality.", - "type": "boolean" - } - } - }, - "QuestionAnsweringParameters": { - "type": "object", - "description": "This is a set of request parameters for Question Answering knowledge bases.", - "x-ms-discriminator-value": "QuestionAnswering", - "allOf": [ - { - "$ref": "#/definitions/AnalysisParameters" - } - ], - "properties": { - "callingOptions": { - "description": "The options sent to a Question Answering KB.", - "$ref": "common.json#/definitions/AnswersOptions" - } - } - }, - "AnalyzeConversationResult": { - "type": "object", - "description": "Represents a conversation analysis response.", - "required": [ - "query", - "prediction" - ], - "properties": { - "query": { - "type": "string", - "description": "The conversation utterance given by the caller." - }, - "detectedLanguage": { - "type": "string", - "description": "The system detected language for the query in BCP 47 language representation.." - }, - "prediction": { - "description": "The prediction result of a conversation project.", - "$ref": "#/definitions/BasePrediction" - } - } - }, - "BasePrediction": { - "type": "object", - "description": "This is the base class of prediction", - "required": [ - "projectKind" - ], - "discriminator": "projectKind", - "properties": { - "projectKind": { - "type": "string", - "description": "The type of the project.", - "enum": [ - "Conversation", - "Orchestration" - ], - "x-ms-enum": { - "name": "projectKind", - "modelAsString": true - } - }, - "topIntent": { - "type": "string", - "description": "The intent with the highest score." - } - } - }, - "OrchestrationPrediction": { - "type": "object", - "description": "This represents the prediction result of an Orchestration project.", - "x-ms-discriminator-value": "Orchestration", - "required": [ - "intents" - ], - "allOf": [ - { - "$ref": "#/definitions/BasePrediction" - } - ], - "properties": { - "intents": { - "description": "A dictionary that contains all intents. A key is an intent name and a value is its confidence score and target type. The top intent's value also contains the actual response from the target project.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TargetIntentResult" - } - } - } - }, - "TargetIntentResult": { - "type": "object", - "description": "This is the base class of an intent prediction", - "discriminator": "targetProjectKind", - "required": [ - "confidenceScore", - "targetProjectKind" - ], - "properties": { - "targetProjectKind": { - "type": "string", - "description": "This discriminator property specifies the type of the target project that returns the response.", - "enum": [ - "Luis", - "Conversation", - "QuestionAnswering", - "NonLinked" - ], - "x-ms-enum": { - "name": "targetProjectKind", - "modelAsString": true - } - }, - "apiVersion": { - "type": "string", - "description": "The API version used to call a target service." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidence", - "description": "The prediction score and it ranges from 0.0 to 1.0.", - "minimum": 0, - "maximum": 1 - } - } - }, - "ConversationTargetIntentResult": { - "type": "object", - "description": "A wrap up of Conversation project response.", - "x-ms-discriminator-value": "Conversation", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "type": "object", - "$ref": "#/definitions/ConversationResult", - "description": "The actual response from a Conversation project." - } - } - }, - "ConversationResult": { - "type": "object", - "description": "The response returned by a Conversation project.", - "required": [ - "query" - ], - "properties": { - "query": { - "description": "The same query given in request.", - "type": "string" - }, - "detectedLanguage": { - "description": "The detected language from the query in BCP 47 language representation..", - "type": "string" - }, - "prediction": { - "description": "The predicted result for the query.", - "$ref": "#/definitions/ConversationPrediction" - } - } - }, - "ConversationPrediction": { - "type": "object", - "description": "Represents the prediction section of a Conversation project.", - "x-ms-discriminator-value": "Conversation", - "required": [ - "intents", - "entities" - ], - "allOf": [ - { - "$ref": "#/definitions/BasePrediction" - } - ], - "properties": { - "intents": { - "description": "The intent classification results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationIntent" - } - }, - "entities": { - "description": "The entity extraction results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationEntity" - } - } - } - }, - "ConversationIntent": { - "type": "object", - "description": "The intent classification result of a Conversation project.", - "required": [ - "category", - "confidenceScore" - ], - "properties": { - "category": { - "description": "A predicted class.", - "type": "string" - }, - "confidenceScore": { - "format": "float", - "x-ms-client-name": "confidence", - "description": "The confidence score of the class from 0.0 to 1.0.", - "type": "number", - "minimum": 0, - "maximum": 1 - } - } - }, - "ConversationEntity": { - "type": "object", - "description": "The entity extraction result of a Conversation project.", - "required": [ - "category", - "text", - "offset", - "length", - "confidenceScore" - ], - "properties": { - "category": { - "description": "The entity category.", - "type": "string" - }, - "text": { - "description": "The predicted entity text.", - "type": "string" - }, - "offset": { - "format": "int32", - "description": "The starting index of this entity in the query.", - "type": "integer" - }, - "length": { - "format": "int32", - "description": "The length of the text.", - "type": "integer" - }, - "confidenceScore": { - "format": "float", - "x-ms-client-name": "confidence", - "description": "The entity confidence score.", - "type": "number" - }, - "resolutions": { - "description": "The collection of entity resolution objects.", - "type": "array", - "items": { - "$ref": "#/definitions/BaseResolution" - } - }, - "extraInformation": { - "description": "The collection of entity extra information objects.", - "type": "array", - "items": { - "$ref": "#/definitions/BaseExtraInformation" - } - } - } - }, - "BaseResolution": { - "description": "The abstract base class for entity resolutions.", - "type": "object", - "discriminator": "resolutionKind", - "properties": { - "resolutionKind": { - "description": "The entity resolution object kind.", - "type": "string", - "enum": [ - "BooleanResolution", - "DateTimeResolution", - "NumberResolution", - "OrdinalResolution", - "SpeedResolution", - "WeightResolution", - "LengthResolution", - "VolumeResolution", - "AreaResolution", - "AgeResolution", - "InformationResolution", - "TemperatureResolution", - "CurrencyResolution", - "NumericRangeResolution", - "TemporalSpanResolution" - ], - "x-ms-enum": { - "name": "ResolutionKind", - "modelAsString": true - } - } - }, - "required": [ - "resolutionKind" - ] - }, - "QuantityResolution": { - "description": "Represents resolutions for quantities.", - "type": "object", - "properties": { - "value": { - "type": "number", - "format": "double", - "description": "The numeric value that the extracted text denotes." - } - }, - "required": [ - "value" - ] - }, - "AgeResolution": { - "description": "Represents the Age entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "AgeResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Year", - "Month", - "Week", - "Day" - ], - "x-ms-enum": { - "name": "AgeUnit", - "modelAsString": true - }, - "description": "The Age Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "VolumeResolution": { - "description": "Represents the volume entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "VolumeResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "CubicMeter", - "CubicCentimeter", - "CubicMillimeter", - "Hectoliter", - "Decaliter", - "Liter", - "Centiliter", - "Milliliter", - "CubicYard", - "CubicInch", - "CubicFoot", - "CubicMile", - "FluidOunce", - "Teaspoon", - "Tablespoon", - "Pint", - "Quart", - "Cup", - "Gill", - "Pinch", - "FluidDram", - "Barrel", - "Minim", - "Cord", - "Peck", - "Bushel", - "Hogshead" - ], - "x-ms-enum": { - "name": "VolumeUnit", - "modelAsString": true - }, - "description": "The Volume Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "SpeedResolution": { - "description": "Represents the speed entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "SpeedResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "MetersPerSecond", - "KilometersPerHour", - "KilometersPerMinute", - "KilometersPerSecond", - "MilesPerHour", - "Knot", - "FootPerSecond", - "FootPerMinute", - "YardsPerMinute", - "YardsPerSecond", - "MetersPerMillisecond", - "CentimetersPerMillisecond", - "KilometersPerMillisecond" - ], - "x-ms-enum": { - "name": "SpeedUnit", - "modelAsString": true - }, - "description": "The speed Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "AreaResolution": { - "description": "Represents the area entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "AreaResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "SquareKilometer", - "SquareHectometer", - "SquareDecameter", - "SquareDecimeter", - "SquareMeter", - "SquareCentimeter", - "SquareMillimeter", - "SquareInch", - "SquareFoot", - "SquareMile", - "SquareYard", - "Acre" - ], - "x-ms-enum": { - "name": "AreaUnit", - "modelAsString": true - }, - "description": "The area Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "LengthResolution": { - "description": "Represents the length entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "LengthResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Kilometer", - "Hectometer", - "Decameter", - "Meter", - "Decimeter", - "Centimeter", - "Millimeter", - "Micrometer", - "Nanometer", - "Picometer", - "Mile", - "Yard", - "Inch", - "Foot", - "LightYear", - "Pt" - ], - "x-ms-enum": { - "name": "LengthUnit", - "modelAsString": true - }, - "description": "The length Unit of measurement" - } - }, - "required": [ - "unit" - ] - }, - "InformationResolution": { - "description": "Represents the information (data) entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "InformationResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Bit", - "Kilobit", - "Megabit", - "Gigabit", - "Terabit", - "Petabit", - "Byte", - "Kilobyte", - "Megabyte", - "Gigabyte", - "Terabyte", - "Petabyte" - ], - "x-ms-enum": { - "name": "InformationUnit", - "modelAsString": true - }, - "description": "The information (data) Unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "TemperatureResolution": { - "description": "Represents the temperature entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "TemperatureResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Fahrenheit", - "Kelvin", - "Rankine", - "Celsius" - ], - "x-ms-enum": { - "name": "TemperatureUnit", - "modelAsString": true - }, - "description": "The temperature Unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "WeightResolution": { - "description": "Represents the weight entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "WeightResolution", - "properties": { - "unit": { - "type": "string", - "enum": [ - "Unspecified", - "Kilogram", - "Gram", - "Milligram", - "Gallon", - "MetricTon", - "Ton", - "Pound", - "Ounce", - "Grain", - "PennyWeight", - "LongTonBritish", - "ShortTonUS", - "ShortHundredWeightUS", - "Stone", - "Dram" - ], - "x-ms-enum": { - "name": "WeightUnit", - "modelAsString": true - }, - "description": "The weight Unit of measurement." - } - }, - "required": [ - "unit" - ] - }, - "CurrencyResolution": { - "description": "Represents the currency entity resolution model.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - }, - { - "$ref": "#/definitions/QuantityResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "CurrencyResolution", - "properties": { - "ISO4217": { - "type": "string", - "description": "The alphabetic code based on another ISO standard, ISO 3166, which lists the codes for country names. The first two letters of the ISO 4217 three-letter code are the same as the code for the country name, and, where possible, the third letter corresponds to the first letter of the currency name." - }, - "value": { - "type": "number", - "format": "double", - "description": "The money amount captured in the extracted entity" - }, - "unit": { - "type": "string", - "description": "The unit of the amount captured in the extracted entity" - } - }, - "required": [ - "value", - "unit" - ] - }, - "BooleanResolution": { - "description": "A resolution for boolean expressions", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "BooleanResolution", - "properties": { - "value": { - "type": "boolean" - } - }, - "required": [ - "value" - ] - }, - "DateTimeResolution": { - "description": "A resolution for datetime entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "DateTimeResolution", - "properties": { - "timex": { - "$ref": "#/definitions/TimeExpression" - }, - "dateTimeSubKind": { - "type": "string", - "enum": [ - "Time", - "Date", - "DateTime", - "Duration", - "Set" - ], - "x-ms-enum": { - "name": "DateTimeSubKind", - "modelAsString": true - }, - "description": "The DateTime SubKind" - }, - "value": { - "type": "string", - "description": "The actual time that the extracted text denote." - }, - "modifier": { - "$ref": "#/definitions/TemporalModifier" - } - }, - "required": [ - "timex", - "dateTimeSubKind", - "value" - ] - }, - "NumberResolution": { - "description": "A resolution for numeric entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "NumberResolution", - "properties": { - "numberKind": { - "type": "string", - "enum": [ - "Integer", - "Decimal", - "Power", - "Fraction", - "Percent", - "Unspecified" - ], - "x-ms-enum": { - "name": "NumberKind", - "modelAsString": true - }, - "description": "The type of the extracted number entity." - }, - "value": { - "type": "number", - "format": "double", - "description": "A numeric representation of what the extracted text denotes." - } - }, - "required": [ - "numberKind", - "value" - ] - }, - "OrdinalResolution": { - "description": "A resolution for ordinal numbers entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "OrdinalResolution", - "properties": { - "offset": { - "type": "string", - "description": "The offset With respect to the reference (e.g., offset = -1 in \"show me the second to last\"" - }, - "relativeTo": { - "type": "string", - "enum": [ - "Current", - "End", - "Start" - ], - "x-ms-enum": { - "name": "RelativeTo", - "modelAsString": true - }, - "description": "The reference point that the ordinal number denotes." - }, - "value": { - "type": "string", - "description": "A simple arithmetic expression that the ordinal denotes." - } - }, - "required": [ - "offset", - "relativeTo", - "value" - ] - }, - "TemporalSpanResolution": { - "description": "represents the resolution of a date and/or time span.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "TemporalSpanResolution", - "properties": { - "begin": { - "$ref": "#/definitions/TimeExpression" - }, - "end": { - "$ref": "#/definitions/TimeExpression" - }, - "duration": { - "type": "string", - "description": "An optional duration value formatted based on the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)" - }, - "modifier": { - "$ref": "#/definitions/TemporalModifier" - }, - "timex": { - "type": "string", - "description": "An optional triplet containing the beginning, the end, and the duration all stated as ISO 8601 formatted strings." - } - } - }, - "NumericRangeResolution": { - "description": "represents the resolution of numeric intervals.", - "allOf": [ - { - "$ref": "#/definitions/BaseResolution" - } - ], - "type": "object", - "x-ms-discriminator-value": "NumericRangeResolution", - "properties": { - "rangeKind": { - "type": "string", - "enum": [ - "Number", - "Speed", - "Weight", - "Length", - "Volume", - "Area", - "Age", - "Information", - "Temperature", - "Currency" - ], - "x-ms-enum": { - "name": "RangeKind", - "modelAsString": true - }, - "description": "The kind of range that the resolution object represents." - }, - "minimum": { - "type": "number", - "format": "double", - "description": "The beginning value of the interval." - }, - "maximum": { - "type": "number", - "format": "double", - "description": "The ending value of the interval." - } - }, - "required": [ - "rangeKind", - "minimum", - "maximum" - ] - }, - "TemporalModifier": { - "type": "string", - "description": "An optional modifier of a date/time instance.", - "enum": [ - "AfterApprox", - "Before", - "BeforeStart", - "Approx", - "ReferenceUndefined", - "SinceEnd", - "AfterMid", - "Start", - "After", - "BeforeEnd", - "Until", - "End", - "Less", - "Since", - "AfterStart", - "BeforeApprox", - "Mid", - "More" - ], - "x-ms-enum": { - "name": "TemporalModifier", - "modelAsString": true - } - }, - "TimeExpression": { - "type": "string", - "description": "An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)" - }, - "BaseExtraInformation": { - "description": "The abstract base object for entity extra information.", - "type": "object", - "discriminator": "extraInformationKind", - "properties": { - "extraInformationKind": { - "description": "The extra information object kind.", - "type": "string", - "enum": [ - "EntitySubtype", - "ListKey", - "RegexKey" - ], - "x-ms-enum": { - "name": "ExtraInformationKind", - "modelAsString": true - } - } - }, - "required": [ - "extraInformationKind" - ] - }, - "EntitySubtype": { - "description": "The concrete entity Subtype model of extra information.", - "allOf": [ - { - "$ref": "#/definitions/BaseExtraInformation" - } - ], - "type": "object", - "x-ms-discriminator-value": "EntitySubtype", - "properties": { - "value": { - "type": "string", - "description": "The Subtype of an extracted entity type." - } - } - }, - "ListKey": { - "description": "The list key extra data kind.", - "allOf": [ - { - "$ref": "#/definitions/BaseExtraInformation" - } - ], - "type": "object", - "x-ms-discriminator-value": "ListKey", - "properties": { - "key": { - "type": "string", - "description": "The canonical form of the extracted entity." - } - } - }, - "RegexKey": { - "description": "The regex key extra data kind.", - "allOf": [ - { - "$ref": "#/definitions/BaseExtraInformation" - } - ], - "type": "object", - "x-ms-discriminator-value": "RegexKey", - "properties": { - "key": { - "type": "string", - "description": "The key of the regex pattern used in extracting the entity." - }, - "regexPattern": { - "type": "string", - "description": "The .NET regex pattern used in extracting the entity. Please visit https://docs.microsoft.com/dotnet/standard/base-types/regular-expressions for more information about .NET regular expressions." - } - } - }, - "LuisTargetIntentResult": { - "type": "object", - "description": "It is a wrap up of LUIS Generally Available response.", - "x-ms-discriminator-value": "Luis", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "type": "object", - "description": "The actual response from a LUIS Generally Available application." - } - } - }, - "QuestionAnsweringTargetIntentResult": { - "type": "object", - "description": "It is a wrap up a Question Answering KB response.", - "x-ms-discriminator-value": "QuestionAnswering", - "allOf": [ - { - "$ref": "#/definitions/TargetIntentResult" - } - ], - "properties": { - "result": { - "description": "The generated answer by a Question Answering KB.", - "$ref": "common.json#/definitions/AnswersResult" - } - } - }, - "AnalyzeConversationJobsInput": { - "type": "object", - "properties": { - "displayName": { - "description": "Optional display name for the analysis job.", - "type": "string" - }, - "analysisInput": { - "$ref": "#/definitions/MultiLanguageConversationAnalysisInput" - }, - "tasks": { - "description": "The set of tasks to execute on the input conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeConversationLROTask" - } - } - }, - "required": [ - "analysisInput", - "tasks" - ] - }, - "AnalyzeConversationLROTask": { - "type": "object", - "description": "The base class for an long running conversation input task.", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationLROTaskKind" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskIdentifier" - } - ] - }, - "AnalyzeConversationLROTaskKind": { - "type": "string", - "description": "Enumeration of supported analysis tasks on a collection of conversation.", - "enum": [ - "ConversationalPIITask", - "ConversationalSummarizationTask", - "CustomConversationalSummarizationTask", - "ConversationalSentimentTask" - ], - "x-ms-enum": { - "name": "AnalyzeConversationLROTaskKind", - "modelAsString": true - } - }, - "AnalyzeConversationResultsKind": { - "type": "string", - "description": "Enumeration of supported Conversation Analysis task results.", - "enum": [ - "ConversationalPIIResults", - "ConversationalSummarizationResults", - "CustomConversationalSummarizationResults", - "ConversationalSentimentResults" - ], - "x-ms-enum": { - "name": "AnalyzeConversationResultsKind", - "modelAsString": true - } - }, - "AnalyzeConversationPIITask": { - "type": "object", - "description": "Task definition for a PII redaction in conversations.", - "properties": { - "parameters": { - "$ref": "#/definitions/ConversationPIITaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationLROTask" - } - ], - "x-ms-discriminator-value": "ConversationalPIITask" - }, - "ConversationPIIItemResult": { - "type": "object", - "required": [ - "id", - "redactedContent", - "entities" - ], - "properties": { - "id": { - "type": "string" - }, - "redactedContent": { - "type": "object", - "$ref": "#/definitions/RedactedTranscriptContent" - }, - "entities": { - "type": "array", - "items": { - "$ref": "#/definitions/Entity" - } - } - } - }, - "MultiLanguageConversationAnalysisInput": { - "type": "object", - "required": [ - "conversations" - ], - "properties": { - "conversations": { - "type": "array", - "items": { - "$ref": "#/definitions/Conversation" - } - } - } - }, - "Conversation": { - "type": "object", - "description": "A complete ordered set of utterances (spoken or written), by one or more speakers to be used for analysis.", - "discriminator": "modality", - "required": [ - "id", - "language", - "modality" - ], - "properties": { - "id": { - "description": "Unique identifier for the conversation.", - "type": "string" - }, - "language": { - "description": "The language of the conversation item in BCP-47 format.", - "type": "string" - }, - "modality": { - "$ref": "#/definitions/Modality" - }, - "domain": { - "$ref": "#/definitions/ConversationDomain" - } - } - }, - "Modality": { - "type": "string", - "description": "Enumeration of supported conversational modalities.", - "enum": [ - "transcript", - "text" - ], - "x-ms-enum": { - "name": "InputModality", - "modelAsString": true - } - }, - "ConversationDomain": { - "type": "string", - "description": "Enumeration of supported conversational domains.", - "enum": [ - "finance", - "healthcare", - "generic" - ], - "x-ms-enum": { - "name": "ConversationDomain", - "modelAsString": true - } - }, - "TextConversation": { - "type": "object", - "x-ms-discriminator-value": "text", - "required": [ - "conversationItems" - ], - "allOf": [ - { - "$ref": "#/definitions/Conversation" - } - ], - "properties": { - "conversationItems": { - "description": "Ordered list of text conversation items in the conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/TextConversationItem" - } - } - } - }, - "TranscriptConversation": { - "type": "object", - "x-ms-discriminator-value": "transcript", - "required": [ - "conversationItems" - ], - "allOf": [ - { - "$ref": "#/definitions/Conversation" - } - ], - "properties": { - "conversationItems": { - "description": "Ordered list of transcript conversation items in the conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/TranscriptConversationItem" - } - } - } - }, - "TranscriptConversationItem": { - "type": "object", - "description": "Additional properties for supporting transcript conversation.", - "required": [ - "text", - "lexical", - "itn", - "maskedItn" - ], - "allOf": [ - { - "$ref": "#/definitions/ConversationItemBase" - } - ], - "properties": { - "itn": { - "type": "string", - "description": "Inverse Text Normalization representation of input. The inverse-text-normalized form is the recognized text from Microsoft's Speech to Text API, with phone numbers, numbers, abbreviations, and other transformations applied." - }, - "maskedItn": { - "type": "string", - "description": "The Inverse Text Normalized format with profanity masking applied." - }, - "text": { - "type": "string", - "description": "The display form of the recognized text from speech to text API, with punctuation and capitalization added." - }, - "lexical": { - "type": "string", - "description": "The lexical form of the recognized text from speech to text API with the actual words recognized." - }, - "wordLevelTimings": { - "type": "array", - "description": "The list of word level audio timing information", - "items": { - "$ref": "#/definitions/WordLevelTiming" - } - }, - "conversationItemLevelTiming": { - "description": "Conversation item level audio timing. This still can help on AI quality if word level audio timings are not available.", - "$ref": "#/definitions/ConversationItemLevelTiming" - } - } - }, - "RedactedTranscriptContent": { - "type": "object", - "description": "The transcript content response generated by the service with all necessary personally identifiable information redacted.", - "properties": { - "itn": { - "type": "string", - "description": "The redacted output for inverse text normalized format input." - }, - "maskedItn": { - "type": "string", - "description": "The redacted output for masked inverse text normalized format input." - }, - "text": { - "type": "string", - "description": "The redacted output for text (Microsoft's Speech to Text 'display') format input." - }, - "lexical": { - "type": "string", - "description": "The redacted output for lexical format input." - }, - "audioTimings": { - "type": "array", - "description": "The list of redacted audio segments.", - "items": { - "$ref": "#/definitions/AudioTiming" - } - } - } - }, - "WordLevelTiming": { - "type": "object", - "description": "Word level timing information generated by the speech to text API. The words in this object should have 1:1 correspondence with the 'lexical' input to allow for audio redaction.", - "properties": { - "word": { - "type": "string", - "description": "The word recognized." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AudioTiming" - } - ] - }, - "AudioTiming": { - "type": "object", - "description": "The audio timing information.", - "properties": { - "offset": { - "description": "Offset from start of speech audio, in ticks. 1 tick = 100 ns.", - "type": "integer", - "format": "int64" - }, - "duration": { - "description": "Duration of word articulation, in ticks. 1 tick = 100 ns.", - "type": "integer", - "format": "int64" - } - } - }, - "Entity": { - "type": "object", - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ], - "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "type": "string", - "description": "Entity type." - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub type." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted entity." - } - } - }, - "AnalyzeConversationConversationPIIResult": { - "type": "object", - "description": "Result from the personally identifiable information detection and redaction operation performed on a list of conversations.", - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationJobResult" - } - ], - "properties": { - "results": { - "$ref": "#/definitions/ConversationPIIResults" - } - }, - "required": [ - "results" - ], - "x-ms-discriminator-value": "ConversationalPIIResults" - }, - "ConversationPIIResults": { - "type": "object", - "description": "The result from PII detection and redaction operation for each conversation.", - "required": [ - "conversations" - ], - "properties": { - "conversations": { - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalPIIResultWithResultBase" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ] - }, - "ConversationalPIIResultWithResultBase": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationPIIResult" - }, - { - "$ref": "#/definitions/ConversationResultBase" - } - ] - }, - "ConversationPIIResult": { - "type": "object", - "description": "The result from PII detection and redaction operation for each conversation.", - "required": [ - "conversationItems" - ], - "properties": { - "conversationItems": { - "description": "Enumeration of PII detection and redaction operation results for all the conversation items in a conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationPIIItemResult" - } - } - } - }, - "ConversationPIITaskParameters": { - "type": "object", - "description": "Supported parameters for a Conversational PII detection and redaction task.", - "properties": { - "piiCategories": { - "$ref": "#/definitions/ConversationPIICategories" - }, - "redactAudioTiming": { - "type": "boolean", - "description": "Flag to indicate if response should include audio stream offset and duration for any detected entities to be redacted. By default, audio timing of redacted entities are not included.", - "default": false - }, - "redactionSource": { - "type": "string", - "description": "For transcript conversations, this parameter provides information regarding which content type (ITN, Text, Lexical, Masked ITN) should be used for entity detection. The details of the entities detected - like the offset, length and the text itself - will correspond to the text type selected here.", - "$ref": "#/definitions/TranscriptContentType" - }, - "redactionCharacter": { - "$ref": "common.json#/definitions/RedactionCharacter" - }, - "excludePiiCategories": { - "description": "List of categories that need to be excluded instead of included.", - "$ref": "#/definitions/ConversationPIICategoriesExclude" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "ConversationPIICategories": { - "description": "Describes the PII categories to return for detection. If not provided, 'default' categories will be returned which will vary with the language.", - "items": { - "type": "string", - "x-ms-enum": { - "name": "ConversationPIICategory", - "modelAsString": true - }, - "enum": [ - "Address", - "CreditCardNumber", - "Email", - "Person", - "NumericIdentifier", - "PhoneNumber", - "USSocialSecurityNumber", - "Miscellaneous", - "All", - "Default" - ] - }, - "type": "array", - "uniqueItems": true - }, - "ConversationPIICategoriesExclude": { - "description": "Describes the PII categories to exclude for detection. If not provided, 'default' categories will be returned which will vary with the language.", - "items": { - "type": "string", - "x-ms-enum": { - "name": "ConversationPIICategoriesExclude", - "modelAsString": true - }, - "enum": [ - "Address", - "CreditCardNumber", - "Email", - "Person", - "NumericIdentifier", - "PhoneNumber", - "USSocialSecurityNumber" - ] - }, - "type": "array", - "uniqueItems": true - }, - "TranscriptContentType": { - "type": "string", - "description": "Enumeration of supported transcript content types.", - "enum": [ - "lexical", - "itn", - "maskedItn", - "text" - ], - "x-ms-enum": { - "name": "TranscriptContentType", - "modelAsString": true - } - }, - "AnalyzeConversationSummarizationTask": { - "type": "object", - "description": "Task definition for conversational summarization.", - "properties": { - "parameters": { - "$ref": "#/definitions/ConversationSummarizationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationLROTask" - } - ], - "x-ms-discriminator-value": "ConversationalSummarizationTask" - }, - "AnalyzeCustomConversationSummarizationTask": { - "type": "object", - "description": "Task definition for custom conversational summarization.", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomConversationSummarizationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationLROTask" - } - ], - "x-ms-discriminator-value": "CustomConversationalSummarizationTask" - }, - "ConversationSummarizationTaskParametersBase": { - "type": "object", - "description": "Supported parameters for any conversational summarization task.", - "required": [ - "summaryAspects" - ], - "properties": { - "summaryAspects": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "issue", - "resolution", - "chapterTitle", - "narrative" - ], - "x-ms-enum": { - "name": "SummaryAspect", - "modelAsString": true, - "values": [ - { - "value": "issue", - "description": "A summary of issues in transcripts of web chats and service call transcripts between customer-service agents, and your customers." - }, - { - "value": "resolution", - "description": "A summary of resolutions in transcripts of web chats and service call transcripts between customer-service agents, and your customers." - }, - { - "value": "chapterTitle", - "description": "A chapter title of any conversation. It is usually one phrase or several phrases naturally combined together. Long conversation tends to have more chapters. The chapter boundary can be found from the summary context." - }, - { - "value": "narrative", - "description": "A generic narrative summary of any conversation. It generally converts the conversational language into formal written language, compresses the text length and keeps the salient information." - } - ] - } - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/AbstractiveSummarizationTaskParametersBase" - } - ] - }, - "ConversationSummarizationTaskParameters": { - "type": "object", - "description": "Supported parameters for pre-build conversational summarization task.", - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - }, - { - "$ref": "#/definitions/ConversationSummarizationTaskParametersBase" - } - ] - }, - "CustomConversationSummarizationTaskParameters": { - "type": "object", - "description": "Supported parameters for a custom conversation summarization task.", - "allOf": [ - { - "$ref": "common.json#/definitions/CustomTaskParameters" - }, - { - "$ref": "#/definitions/ConversationSummarizationTaskParametersBase" - } - ] - }, - "AnalyzeConversationSummarizationResult": { - "type": "object", - "description": "Result for the summarization task on the conversation.", - "properties": { - "results": { - "$ref": "#/definitions/SummaryResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationJobResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "ConversationalSummarizationResults" - }, - "AnalyzeCustomConversationSummarizationResult": { - "type": "object", - "description": "Result for the custom summarization task on the conversation.", - "properties": { - "results": { - "$ref": "#/definitions/CustomSummaryResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationJobResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomConversationalSummarizationResults" - }, - "SummaryResultBase": { - "type": "object", - "required": [ - "conversations" - ], - "properties": { - "conversations": { - "type": "array", - "items": { - "$ref": "#/definitions/ConversationsSummaryResult" - } - } - } - }, - "SummaryResult": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/SummaryResultBase" - }, - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ] - }, - "CustomSummaryResult": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/SummaryResultBase" - }, - { - "$ref": "common.json#/definitions/CustomResult" - } - ] - }, - "ConversationsSummaryResult": { - "type": "object", - "required": [ - "summaries" - ], - "properties": { - "summaries": { - "type": "array", - "items": { - "$ref": "#/definitions/SummaryResultItem" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/ConversationResultBase" - } - ] - }, - "SummaryResultItem": { - "type": "object", - "properties": { - "aspect": { - "type": "string" - }, - "text": { - "type": "string" - }, - "contexts": { - "type": "array", - "description": "The context list of the summary.", - "items": { - "$ref": "#/definitions/ItemizedSummaryContext" - } - } - }, - "required": [ - "aspect", - "text" - ] - }, - "AnalyzeConversationalSentimentTask": { - "type": "object", - "description": "Task definition for a sentiment analysis in conversations.", - "properties": { - "parameters": { - "$ref": "#/definitions/ConversationalSentimentTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationLROTask" - } - ], - "x-ms-discriminator-value": "ConversationalSentimentTask" - }, - "ConversationalSentimentTaskParameters": { - "type": "object", - "description": "Supported parameters for a Conversational sentiment analysis task.", - "properties": { - "predictionSource": { - "type": "string", - "description": "For transcript conversations, this parameter provides information regarding which content type should be used for sentiment analysis. The details of the sentiment analysis - like the offset, length and the text itself - will correspond to the text type selected here.", - "$ref": "#/definitions/TranscriptContentType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "AnalyzeConversationSentimentResult": { - "type": "object", - "description": "Result from the sentiment analysis operation performed on a list of conversations.", - "allOf": [ - { - "$ref": "#/definitions/AnalyzeConversationJobResult" - } - ], - "properties": { - "results": { - "$ref": "#/definitions/ConversationSentimentResults" - } - }, - "required": [ - "results" - ], - "x-ms-discriminator-value": "ConversationalSentimentResults" - }, - "ConversationSentimentResults": { - "type": "object", - "description": "The result from sentiment analysis operation for each conversation.", - "required": [ - "conversations" - ], - "properties": { - "conversations": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "#/definitions/ConversationSentimentResult" - }, - { - "$ref": "#/definitions/ConversationResultBase" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ] - }, - "ConversationSentimentResult": { - "type": "object", - "description": "The result from sentiment analysis operation for each conversation item.", - "required": [ - "conversationItems" - ], - "properties": { - "conversationItems": { - "description": "Enumeration of Sentiment operation results for all the conversation items in a conversation.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationSentimentItemResult" - } - } - } - }, - "ConversationSentimentItemResult": { - "type": "object", - "required": [ - "id", - "participantId", - "sentiment", - "confidenceScores" - ], - "properties": { - "id": { - "description": "The identifier for the conversation item", - "type": "string" - }, - "participantId": { - "description": "The identifier for the speaker", - "type": "string" - }, - "sentiment": { - "$ref": "common.json#/definitions/Sentiment" - }, - "confidenceScores": { - "type": "object", - "$ref": "common.json#/definitions/SentimentConfidenceScores" - } - } - }, - "AnalyzeConversationJobState": { - "description": "Contains the status of the analyze conversations job submitted along with related statistics.", - "allOf": [ - { - "$ref": "common.json#/definitions/JobState" - }, - { - "$ref": "#/definitions/ConversationTasksState" - }, - { - "$ref": "#/definitions/AnalyzeConversationJobStatistics" - } - ] - }, - "AnalyzeConversationJobStatistics": { - "description": "Contains the statistics for the job submitted.", - "properties": { - "statistics": { - "$ref": "#/definitions/ConversationRequestStatistics" - } - }, - "type": "object" - }, - "ConversationTasksState": { - "description": "Contains the state for the tasks being executed as part of the analyze conversation job submitted.", - "properties": { - "tasks": { - "properties": { - "completed": { - "description": "Count of tasks completed successfully.", - "type": "integer", - "format": "int32" - }, - "failed": { - "description": "Count of tasks that failed.", - "type": "integer", - "format": "int32" - }, - "inProgress": { - "description": "Count of tasks in progress currently.", - "type": "integer", - "format": "int32" - }, - "total": { - "description": "Total count of tasks submitted as part of the job.", - "type": "integer", - "format": "int32" - }, - "items": { - "description": "List of results from tasks (if available).", - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeConversationJobResult" - } - } - }, - "required": [ - "total", - "completed", - "failed", - "inProgress" - ], - "type": "object" - } - }, - "required": [ - "tasks" - ], - "type": "object" - }, - "AnalyzeConversationJobResult": { - "type": "object", - "description": "Container for results for all tasks in the conversation job.", - "discriminator": "kind", - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeConversationResultsKind" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskState" - }, - { - "$ref": "common.json#/definitions/TaskIdentifier" - } - ], - "required": [ - "kind" - ] - }, - "ConversationResultBase": { - "type": "object", - "description": "Shared attributes for all conversational task results.", - "required": [ - "id", - "warnings" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique, non-empty conversation identifier." - }, - "warnings": { - "type": "array", - "description": "Warnings encountered while processing document.", - "items": { - "$ref": "common.json#/definitions/InputWarning" - } - }, - "statistics": { - "$ref": "#/definitions/ConversationStatistics" - } - } - }, - "ConversationStatistics": { - "type": "object", - "description": "If showStats=true was specified in the request this field will contain information about the conversation payload.", - "required": [ - "transactionsCount" - ], - "properties": { - "transactionsCount": { - "type": "integer", - "format": "int32", - "description": "Number of text units for the request." - } - } - }, - "ConversationRequestStatistics": { - "type": "object", - "description": "if showStats=true was specified in the request this field will contain information about the request payload.", - "required": [ - "conversationsCount", - "validConversationsCount", - "erroneousConversationsCount" - ], - "properties": { - "conversationsCount": { - "type": "integer", - "format": "int32", - "description": "Number of conversations submitted in the request." - }, - "validConversationsCount": { - "type": "integer", - "format": "int32", - "description": "Number of conversations documents. This excludes empty, over-size limit or non-supported languages documents." - }, - "erroneousConversationsCount": { - "type": "integer", - "format": "int32", - "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/RequestStatistics" - } - ] - }, - "ConversationItemLevelTiming": { - "type": "object", - "description": "The conversation item level audio timing.", - "allOf": [ - { - "$ref": "#/definitions/AudioTiming" - } - ] - }, - "ItemizedSummaryContext": { - "type": "object", - "description": "The context of the summary with conversation item id.", - "required": [ - "conversationItemId" - ], - "properties": { - "conversationItemId": { - "type": "string", - "description": "Reference to the id of ConversationItem." - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/SummaryContext" - } - ] - } - }, - "parameters": { - "ConversationAnalysisOptions": { - "name": "ConversationAnalysisOptions", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationAnalysisOptions" - }, - "description": "Post body of the request.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzetext-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzetext-authoring.json deleted file mode 100644 index 9ded7ea9d258..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzetext-authoring.json +++ /dev/null @@ -1,6110 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Analyze Text Authoring", - "version": "2023-04-15-preview", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://learn.microsoft.com/en-us/azure/cognitive-services/language-service/overview.", - "x-typespec-generated": [ - { - "emitter": "@azure-tools/typespec-autorest" - } - ] - }, - "schemes": [ - "https" - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "name": "Endpoint", - "in": "path", - "description": "Supported Cognitive Services endpoint e.g., https://.api.cognitiveservices.azure.com.", - "required": true, - "type": "string", - "format": "url" - } - ] - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "security": [ - { - "ApiKeyAuth": [] - }, - { - "OAuth2Auth": [ - "https://cognitiveservices.azure.com/.default" - ] - } - ], - "securityDefinitions": { - "ApiKeyAuth": { - "type": "apiKey", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - }, - "OAuth2Auth": { - "type": "oauth2", - "flow": "accessCode", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "https://cognitiveservices.azure.com/.default": "" - }, - "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" - } - }, - "tags": [], - "paths": { - "/authoring/analyze-text/projects": { - "get": { - "operationId": "TextAnalysisAuthoringListProjects", - "description": "Lists the existing projects.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedTextAnalysisAuthoringProjectMetadata" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulListProjects": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListProjects.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-text/projects/{projectName}": { - "get": { - "operationId": "TextAuthoringProject_GetProject", - "description": "Gets the details of a project.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetProject": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetProject.json" - } - } - }, - "patch": { - "operationId": "TextAuthoringProject_CreateProject", - "description": "The most basic operation that applies to a resource.", - "consumes": [ - "application/merge-patch+json" - ], - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The request body", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringCreateProjectOptions" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" - } - }, - "201": { - "description": "The request has succeeded and a new resource has been created as a result.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulCreateProject": { - "$ref": "./examples/analyzetext-authoring/SuccessfulCreateProject.json" - } - } - }, - "delete": { - "operationId": "TextAuthoringProject_DeleteProject", - "description": "Deletes a project.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulDeleteProject": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/:authorize-copy": { - "post": { - "operationId": "TextAuthoringProject_CopyProjectAuthorization", - "description": "Generates a copy project operation authorization to the current target Azure resource.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringCopyAuthorizationOptions" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringCopyProjectOptions" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulCopyProjectAuthorization": { - "$ref": "./examples/analyzetext-authoring/SuccessfulCopyProjectAuthorization.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/:copy": { - "post": { - "operationId": "TextAuthoringProject_CopyProject", - "description": "Copies an existing project to another Azure resource.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The copy project info.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringCopyProjectOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulCopyProject": { - "$ref": "./examples/analyzetext-authoring/SuccessfulCopyProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/:export": { - "post": { - "operationId": "TextAuthoringProject_Export", - "description": "Triggers a job to export a project's data.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "stringIndexType", - "in": "query", - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "required": true, - "type": "string", - "enum": [ - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "name": "Utf16CodeUnit", - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - } - }, - { - "name": "assetKind", - "in": "query", - "description": "Kind of asset to export.", - "required": false, - "type": "string" - }, - { - "name": "trainedModelLabel", - "in": "query", - "description": "Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy.", - "required": false, - "type": "string" - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulExportProject": { - "$ref": "./examples/analyzetext-authoring/SuccessfulExportProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/:import": { - "post": { - "operationId": "TextAuthoringProject_Import", - "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "format", - "in": "header", - "description": "The format of the project to import. The currently supported formats are json and aml formats. If not provided, the default is set to json.", - "required": false, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The project data to import.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProject" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulImportProject": { - "$ref": "./examples/analyzetext-authoring/SuccessfulImportProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/:train": { - "post": { - "operationId": "TextAuthoringProject_Train", - "description": "Triggers a training job for a project.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The training input parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulTrainProject": { - "$ref": "./examples/analyzetext-authoring/SuccessfulTrainProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/copy/jobs/{jobId}": { - "get": { - "operationId": "TextAuthoringProject_GetCopyProjectStatus", - "description": "Gets the status of an existing copy project job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringCopyProjectJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetCopyProjectStatus": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetCopyProjectStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments": { - "get": { - "operationId": "TextAnalysisAuthoringListDeployments", - "description": "Lists the deployments belonging to a project.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedTextAnalysisAuthoringProjectDeployment" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulListDeployments": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListDeployments.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}": { - "get": { - "operationId": "TextAuthoringDeployment_GetDeployment", - "description": "Gets the details of a deployment.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "deploymentName", - "in": "path", - "description": "Represents deployment name.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployment" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetDeployment": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetDeployment.json" - } - } - }, - "put": { - "operationId": "TextAuthoringDeployment_DeployProject", - "description": "Creates a new deployment or replaces an existing one.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "deploymentName", - "in": "path", - "description": "The name of the specific deployment of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The new deployment info.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringCreateDeploymentOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulDeployProject": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeployProject.json" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "operationId": "TextAuthoringDeployment_DeleteDeployment", - "description": "Deletes a project deployment.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "deploymentName", - "in": "path", - "description": "The name of the specific deployment of the project to use.", - "required": true, - "type": "string" - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulDeleteDeployment": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteDeployment.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources": { - "post": { - "operationId": "TextAuthoringDeployment_DeleteDeploymentFromResources", - "description": "Deletes a project deployment from the specified assigned resources.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "deploymentName", - "in": "path", - "description": "The name of the specific deployment of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The options for deleting the deployment.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringDeleteDeploymentOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulDeleteDeploymentFromResources": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteDeploymentFromResources.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}": { - "get": { - "operationId": "TextAuthoringDeployment_GetDeploymentDeleteFromResourcesStatus", - "description": "Gets the status of an existing delete deployment from specific resources job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "deploymentName", - "in": "path", - "description": "Represents deployment name.", - "required": true, - "type": "string" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringDeploymentDeleteFromResourcesJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetDeploymentDeleteFromResourcesStatus": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { - "get": { - "operationId": "TextAuthoringDeployment_GetDeploymentStatus", - "description": "Gets the status of an existing deployment job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "deploymentName", - "in": "path", - "description": "Represents deployment name.", - "required": true, - "type": "string" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringDeploymentJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetDeploymentStatus": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/:swap": { - "post": { - "operationId": "TextAuthoringProject_SwapDeployments", - "description": "Swaps two existing deployments with each other.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The job object to swap two deployments.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringSwapDeploymentsOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulSwapDeployments": { - "$ref": "./examples/analyzetext-authoring/SuccessfulSwapDeployments.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}": { - "get": { - "operationId": "TextAuthoringProject_GetSwapDeploymentsStatus", - "description": "Gets the status of an existing swap deployment job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringSwapDeploymentsJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetSwapDeploymentsStatus": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}": { - "get": { - "operationId": "TextAuthoringProject_GetExportStatus", - "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringExportProjectJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetExportStatus": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetExportStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/exported-models": { - "get": { - "operationId": "TextAnalysisAuthoringListExportedModels", - "description": "Lists the exported models belonging to a project.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedTextAnalysisAuthoringExportedTrainedModel" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulListExportedModels": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListExportedModels.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}": { - "get": { - "operationId": "TextAuthoringExportedModel_GetExportedModel", - "description": "Gets the details of an exported model.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "exportedModelName", - "in": "path", - "description": "The exported model name.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedTrainedModel" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetExportedModel": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetExportedModel.json" - } - } - }, - "put": { - "operationId": "TextAuthoringExportedModel_CreateOrUpdateExportedModel", - "description": "Creates a new exported model or replaces an existing one.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "exportedModelName", - "in": "path", - "description": "The exported model name.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The exported model info.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedModelOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulCreateExportedModel": { - "$ref": "./examples/analyzetext-authoring/SuccessfulCreateExportedModel.json" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "operationId": "TextAuthoringExportedModel_DeleteExportedModel", - "description": "Deletes an existing exported model.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "exportedModelName", - "in": "path", - "description": "The exported model name.", - "required": true, - "type": "string" - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulDeleteExportedModel": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteExportedModel.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}/jobs/{jobId}": { - "get": { - "operationId": "TextAuthoringExportedModel_GetExportedModelJobStatus", - "description": "Gets the status for an existing job to create or update an exported model.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "exportedModelName", - "in": "path", - "description": "The exported model name.", - "required": true, - "type": "string" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedModelJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetExportedModelStatus": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetExportedModelStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}/manifest": { - "get": { - "operationId": "TextAuthoringExportedModel_GetExportedModelManifest", - "description": "Gets the details and URL needed to download the exported model.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "exportedModelName", - "in": "path", - "description": "The exported model name.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedModelManifest" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetExportedModelManifest": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetExportedModelManifest.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}": { - "get": { - "operationId": "TextAuthoringProject_GetImportStatus", - "description": "Gets the status for an import.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringImportProjectJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetImportStatus": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetImportStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models": { - "get": { - "operationId": "TextAnalysisAuthoringListTrainedModels", - "description": "Lists the trained models belonging to a project.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedTextAnalysisAuthoringProjectTrainedModel" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulListModels": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListModels.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}": { - "get": { - "operationId": "TextAuthoringTrainedModel_GetTrainedModel", - "description": "Gets the details of a trained model.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "trainedModelLabel", - "in": "path", - "description": "The trained model label.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModel" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetModel": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetModel.json" - } - } - }, - "delete": { - "operationId": "TextAuthoringTrainedModel_DeleteTrainedModel", - "description": "Deletes an existing trained model.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "trainedModelLabel", - "in": "path", - "description": "The trained model label.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulDeleteModel": { - "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteModel.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/:evaluate": { - "post": { - "operationId": "TextAuthoringTrainedModel_EvaluateModel", - "description": "Triggers evaluation operation on a trained model.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "trainedModelLabel", - "in": "path", - "description": "The trained model label.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The training input parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulEvaluationProject": { - "$ref": "./examples/analyzetext-authoring/SuccessfulEvaluationProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot": { - "post": { - "operationId": "TextAuthoringTrainedModel_LoadSnapshot", - "description": "Long-running operation.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "trainedModelLabel", - "in": "path", - "description": "The trained model label.", - "required": true, - "type": "string" - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulLoadSnapshot": { - "$ref": "./examples/analyzetext-authoring/SuccessfulLoadSnapshot.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluate/jobs/{jobId}": { - "get": { - "operationId": "TextAuthoringTrainedModel_GetEvaluationStatus", - "description": "Gets the status for an evaluation job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "trainedModelLabel", - "in": "path", - "description": "The trained model label.", - "required": true, - "type": "string" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetEvaluationStatus": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetEvaluationStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { - "get": { - "operationId": "TextAuthoringTrainedModel_GetModelEvaluationResults", - "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "trainedModelLabel", - "in": "path", - "description": "The trained model label.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - }, - { - "$ref": "#/parameters/StringIndexTypeQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedTextAnalysisAuthoringDocumentEvaluationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetModelEvaluation": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { - "get": { - "operationId": "TextAuthoringTrainedModel_GetModelEvaluationSummary", - "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "trainedModelLabel", - "in": "path", - "description": "The trained model label.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetModelEvaluationSummary": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}": { - "get": { - "operationId": "TextAuthoringTrainedModel_GetLoadSnapshotStatus", - "description": "Gets the status for loading a snapshot.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "trainedModelLabel", - "in": "path", - "description": "The trained model label.", - "required": true, - "type": "string" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringLoadSnapshotJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetLoadSnapshotStatus": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetLoadSnapshotStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/resources": { - "get": { - "operationId": "TextAnalysisAuthoringListDeploymentResources", - "description": "Lists the deployments resources assigned to the project.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedTextAnalysisAuthoringAssignedDeploymentResource" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulListDeploymentResources": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListDeploymentResources.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/resources/:assign": { - "post": { - "operationId": "TextAuthoringProject_AssignDeploymentResources", - "description": "Assign new Azure resources to a project to allow deploying new deployments to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The new project resources info.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringAssignDeploymentResourcesOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Assign Deployment Resources": { - "$ref": "./examples/analyzetext-authoring/SuccessfulAssignDeploymentResources.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/resources/:unassign": { - "post": { - "operationId": "TextAuthoringProject_UnassignDeploymentResources", - "description": "Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The info for the deployment resources to be deleted.", - "required": true, - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringUnassignDeploymentResourcesOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulUnassignDeploymentResources": { - "$ref": "./examples/analyzetext-authoring/SuccessfulUnassignDeploymentResources.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/{projectName}/resources/assign/jobs/{jobId}": { - "get": { - "operationId": "TextAuthoringProject_GetAssignDeploymentResourcesStatus", - "description": "Gets the status of an existing assign deployment resources job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringDeploymentResourcesJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetAssignDeploymentResourcesStatus": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/resources/unassign/jobs/{jobId}": { - "get": { - "operationId": "TextAuthoringProject_GetUnassignDeploymentResourcesStatus", - "description": "Gets the status of an existing unassign deployment resources job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringDeploymentResourcesJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetUnassignDeploymentResourcesStatus": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/train/jobs": { - "get": { - "operationId": "TextAnalysisAuthoringListTrainingJobs", - "description": "Lists the non-expired training jobs created for a project.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedTextAnalysisAuthoringTrainingJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulListTrainingJobs": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListTrainingJobs.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}": { - "get": { - "operationId": "TextAuthoringProject_GetTrainingStatus", - "description": "Gets the status for a training job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The new project name.", - "required": true, - "type": "string" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetTrainStatus": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetTrainStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}/:cancel": { - "post": { - "operationId": "TextAuthoringProject_CancelTrainingJob", - "description": "Triggers a cancellation for a running training job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "The name of the project to use.", - "required": true, - "type": "string" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Successful Cancel Training Job": { - "$ref": "./examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/analyze-text/projects/global/deletion-jobs/{jobId}": { - "get": { - "operationId": "TextAuthoringProject_GetProjectDeletionStatus", - "description": "Gets the status for a project deletion job.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "jobId", - "in": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectDeletionJobState" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetProjectDeletionStatus": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json" - } - } - } - }, - "/authoring/analyze-text/projects/global/deployments/resources": { - "get": { - "operationId": "TextAnalysisAuthoringListAssignedResourceDeployments", - "description": "Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedTextAnalysisAuthoringAssignedProjectDeploymentsMetadata" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulListAssignedResourceDeployments": { - "$ref": "./examples/analyzetext-authoring/SuccessfulListAssignedResourceDeployments.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-text/projects/global/languages": { - "get": { - "operationId": "TextAnalysisAuthoringGetSupportedLanguages", - "description": "Lists the supported languages.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "$ref": "#/parameters/ProjectKindQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedTextAnalysisAuthoringSupportedLanguage" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetSupportedLanguages": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-text/projects/global/prebuilt-entities": { - "get": { - "operationId": "TextAnalysisAuthoringGetSupportedPrebuiltEntities", - "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedTextAnalysisAuthoringPrebuiltEntity" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetSupportedPrebuiltEntities": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetSupportedPrebuiltEntities.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/authoring/analyze-text/projects/global/training-config-versions": { - "get": { - "operationId": "TextAnalysisAuthoringListTrainingConfigVersions", - "description": "Lists the support training config version for a given project type.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "$ref": "#/parameters/ProjectKindQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedTextAnalysisAuthoringTrainingConfigVersion" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "SuccessfulGetSupportedTrainingConfigVersions": { - "$ref": "./examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "Azure.Core.Foundations.Error": { - "type": "object", - "description": "The error object.", - "properties": { - "code": { - "type": "string", - "description": "One of a server-defined set of error codes." - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - }, - "target": { - "type": "string", - "description": "The target of the error." - }, - "details": { - "type": "array", - "description": "An array of details about specific errors that led to this reported error.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "innererror": { - "$ref": "#/definitions/Azure.Core.Foundations.InnerError", - "description": "An object containing more specific information than the current object about the error." - } - }, - "required": [ - "code", - "message" - ] - }, - "Azure.Core.Foundations.ErrorResponse": { - "type": "object", - "description": "A response containing error details.", - "properties": { - "error": { - "$ref": "#/definitions/Azure.Core.Foundations.Error", - "description": "The error object." - } - }, - "required": [ - "error" - ] - }, - "Azure.Core.Foundations.InnerError": { - "type": "object", - "description": "An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.", - "properties": { - "code": { - "type": "string", - "description": "One of a server-defined set of error codes." - }, - "innererror": { - "$ref": "#/definitions/Azure.Core.Foundations.InnerError", - "description": "Inner error." - } - } - }, - "CompositionSetting": { - "type": "string", - "enum": [ - "separateComponents", - "combineComponents" - ], - "x-ms-enum": { - "name": "CompositionSetting", - "modelAsString": true, - "values": [ - { - "name": "separateComponents", - "value": "separateComponents", - "description": "Every component's match or prediction is returned as a separate instance of the entity." - }, - { - "name": "combineComponents", - "value": "combineComponents", - "description": "When two or more components are found in the text and overlap, the components' spans are merged together into one span combining all of them." - } - ] - } - }, - "EvaluationKind": { - "type": "string", - "enum": [ - "percentage", - "manual" - ], - "x-ms-enum": { - "name": "EvaluationKind", - "modelAsString": true, - "values": [ - { - "name": "percentage", - "value": "percentage", - "description": "Split the data into training and test sets according to user-defined percentages." - }, - { - "name": "manual", - "value": "manual", - "description": "Split the data according to the chosen dataset for every example in the data." - } - ] - } - }, - "JobStatus": { - "type": "string", - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling", - "partiallyCompleted" - ], - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true, - "values": [ - { - "name": "notStarted", - "value": "notStarted" - }, - { - "name": "running", - "value": "running" - }, - { - "name": "succeeded", - "value": "succeeded" - }, - { - "name": "failed", - "value": "failed" - }, - { - "name": "cancelled", - "value": "cancelled" - }, - { - "name": "cancelling", - "value": "cancelling" - }, - { - "name": "partiallyCompleted", - "value": "partiallyCompleted" - } - ] - } - }, - "PagedTextAnalysisAuthoringAssignedDeploymentResource": { - "type": "object", - "description": "Paged collection of TextAnalysisAuthoringAssignedDeploymentResource items", - "properties": { - "value": { - "type": "array", - "description": "The TextAnalysisAuthoringAssignedDeploymentResource items on this page", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringAssignedDeploymentResource" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedTextAnalysisAuthoringAssignedProjectDeploymentsMetadata": { - "type": "object", - "description": "Paged collection of TextAnalysisAuthoringAssignedProjectDeploymentsMetadata items", - "properties": { - "value": { - "type": "array", - "description": "The TextAnalysisAuthoringAssignedProjectDeploymentsMetadata items on this page", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringAssignedProjectDeploymentsMetadata" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedTextAnalysisAuthoringDocumentEvaluationResult": { - "type": "object", - "description": "Paged collection of TextAnalysisAuthoringDocumentEvaluationResult items", - "properties": { - "value": { - "type": "array", - "description": "The TextAnalysisAuthoringDocumentEvaluationResult items on this page", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedTextAnalysisAuthoringExportedTrainedModel": { - "type": "object", - "description": "Paged collection of TextAnalysisAuthoringExportedTrainedModel items", - "properties": { - "value": { - "type": "array", - "description": "The TextAnalysisAuthoringExportedTrainedModel items on this page", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedTrainedModel" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedTextAnalysisAuthoringPrebuiltEntity": { - "type": "object", - "description": "Paged collection of TextAnalysisAuthoringPrebuiltEntity items", - "properties": { - "value": { - "type": "array", - "description": "The TextAnalysisAuthoringPrebuiltEntity items on this page", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringPrebuiltEntity" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedTextAnalysisAuthoringProjectDeployment": { - "type": "object", - "description": "Paged collection of TextAnalysisAuthoringProjectDeployment items", - "properties": { - "value": { - "type": "array", - "description": "The TextAnalysisAuthoringProjectDeployment items on this page", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployment" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedTextAnalysisAuthoringProjectMetadata": { - "type": "object", - "description": "Paged collection of TextAnalysisAuthoringProjectMetadata items", - "properties": { - "value": { - "type": "array", - "description": "The TextAnalysisAuthoringProjectMetadata items on this page", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedTextAnalysisAuthoringProjectTrainedModel": { - "type": "object", - "description": "Paged collection of TextAnalysisAuthoringProjectTrainedModel items", - "properties": { - "value": { - "type": "array", - "description": "The TextAnalysisAuthoringProjectTrainedModel items on this page", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModel" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedTextAnalysisAuthoringSupportedLanguage": { - "type": "object", - "description": "Paged collection of TextAnalysisAuthoringSupportedLanguage items", - "properties": { - "value": { - "type": "array", - "description": "The TextAnalysisAuthoringSupportedLanguage items on this page", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringSupportedLanguage" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedTextAnalysisAuthoringTrainingConfigVersion": { - "type": "object", - "description": "Paged collection of TextAnalysisAuthoringTrainingConfigVersion items", - "properties": { - "value": { - "type": "array", - "description": "The TextAnalysisAuthoringTrainingConfigVersion items on this page", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingConfigVersion" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedTextAnalysisAuthoringTrainingJobState": { - "type": "object", - "description": "Paged collection of TextAnalysisAuthoringTrainingJobState items", - "properties": { - "value": { - "type": "array", - "description": "The TextAnalysisAuthoringTrainingJobState items on this page", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobState" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "ProjectKind": { - "type": "string", - "enum": [ - "CustomSingleLabelClassification", - "CustomMultiLabelClassification", - "CustomEntityRecognition", - "CustomAbstractiveSummarization", - "CustomHealthcare", - "CustomTextSentiment" - ], - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "name": "CustomSingleLabelClassification", - "value": "CustomSingleLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B." - }, - { - "name": "CustomMultiLabelClassification", - "value": "CustomMultiLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C." - }, - { - "name": "CustomEntityRecognition", - "value": "CustomEntityRecognition", - "description": "For building an extraction model to identify your domain categories using your own data." - }, - { - "name": "CustomAbstractiveSummarization", - "value": "CustomAbstractiveSummarization", - "description": "For building an abstractive summarization models which are able to summarize long documents." - }, - { - "name": "CustomHealthcare", - "value": "CustomHealthcare", - "description": "For building an text analytics for health model to identify your health domain data." - }, - { - "name": "CustomTextSentiment", - "value": "CustomTextSentiment", - "description": "For building a sentiment models which are able to extract sentiment for long documents." - } - ] - } - }, - "Sentiment": { - "type": "string", - "enum": [ - "positive", - "negative", - "neutral" - ], - "x-ms-enum": { - "name": "Sentiment", - "modelAsString": true, - "values": [ - { - "name": "positive", - "value": "positive" - }, - { - "name": "negative", - "value": "negative" - }, - { - "name": "neutral", - "value": "neutral" - } - ] - } - }, - "StringIndexType": { - "type": "string", - "enum": [ - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "name": "Utf16CodeUnit", - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - } - }, - "TextAnalysisAuthoringAssignDeploymentResourcesOptions": { - "type": "object", - "description": "Represents the options for assigning Azure resources to a project.", - "properties": { - "resourcesMetadata": { - "type": "array", - "description": "Represents the metadata for the resources to be assigned.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringResourceMetadata" - } - } - }, - "required": [ - "resourcesMetadata" - ] - }, - "TextAnalysisAuthoringAssignedDeploymentResource": { - "type": "object", - "description": "Represents the assigned deployment resource.", - "properties": { - "azureResourceId": { - "type": "string", - "description": "The resource ID.", - "readOnly": true - }, - "region": { - "type": "string", - "description": "The resource region." - } - }, - "required": [ - "azureResourceId", - "region" - ] - }, - "TextAnalysisAuthoringAssignedProjectDeploymentMetadata": { - "type": "object", - "description": "Represents the metadata for an assigned deployment", - "properties": { - "deploymentName": { - "type": "string", - "description": "Represents the deployment name." - }, - "lastDeployedDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents deployment last deployed time." - }, - "deploymentExpirationDate": { - "type": "string", - "format": "date", - "description": "Represents deployment expiration date in the runtime." - } - }, - "required": [ - "deploymentName", - "lastDeployedDateTime", - "deploymentExpirationDate" - ] - }, - "TextAnalysisAuthoringAssignedProjectDeploymentsMetadata": { - "type": "object", - "description": "Represents the metadata for assigned deployments for a project.", - "properties": { - "projectName": { - "type": "string", - "description": "Represents the project name.", - "readOnly": true - }, - "deploymentsMetadata": { - "type": "array", - "description": "Represents the resource region.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringAssignedProjectDeploymentMetadata" - } - } - }, - "required": [ - "projectName", - "deploymentsMetadata" - ] - }, - "TextAnalysisAuthoringConfusionMatrixCell": { - "type": "object", - "description": "Represents a cell in a confusion matrix.", - "properties": { - "normalizedValue": { - "type": "number", - "format": "float", - "description": "Represents normalized value in percentages." - }, - "rawValue": { - "type": "number", - "format": "float", - "description": "Represents raw value." - } - }, - "required": [ - "normalizedValue", - "rawValue" - ] - }, - "TextAnalysisAuthoringConfusionMatrixRow": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixCell" - } - }, - "TextAnalysisAuthoringCopyAuthorizationOptions": { - "type": "object", - "description": "Represents the options for authorizing a project copy to the current Azure resource.", - "properties": { - "projectKind": { - "$ref": "#/definitions/ProjectKind", - "description": "Represents the project kind." - }, - "storageInputContainerName": { - "type": "string", - "description": "The name of the storage container." - }, - "allowOverwrite": { - "type": "boolean", - "description": "Whether to allow an existing project to be overwritten using the resulting copy authorization." - } - }, - "required": [ - "projectKind" - ] - }, - "TextAnalysisAuthoringCopyProjectJobState": { - "type": "object", - "description": "Represents the state of a copy job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "TextAnalysisAuthoringCopyProjectOptions": { - "type": "object", - "description": "Represents the options for copying an existing project to another Azure resource.", - "properties": { - "projectKind": { - "$ref": "#/definitions/ProjectKind", - "description": "Represents the project kind." - }, - "targetProjectName": { - "type": "string", - "description": "The project name to be copied-into." - }, - "accessToken": { - "type": "string", - "description": "The access token." - }, - "expiresAt": { - "type": "string", - "format": "date-time", - "description": "The expiration of the access token." - }, - "targetResourceId": { - "type": "string", - "description": "Represents the target Azure resource ID." - }, - "targetResourceRegion": { - "type": "string", - "description": "Represents the target Azure resource region." - } - }, - "required": [ - "projectKind", - "targetProjectName", - "accessToken", - "expiresAt", - "targetResourceId", - "targetResourceRegion" - ] - }, - "TextAnalysisAuthoringCreateDeploymentOptions": { - "type": "object", - "description": "Represents the options for creating or updating a project deployment.", - "properties": { - "trainedModelLabel": { - "type": "string", - "description": "Represents the trained model label." - }, - "assignedResourceIds": { - "type": "array", - "description": "Represents the resource IDs to be assigned to the deployment. If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created.", - "items": { - "type": "string" - } - } - }, - "required": [ - "trainedModelLabel" - ] - }, - "TextAnalysisAuthoringCreateProjectOptions": { - "type": "object", - "description": "Represents the options used to create or update a project.", - "properties": { - "projectKind": { - "$ref": "#/definitions/ProjectKind", - "description": "The project kind." - }, - "storageInputContainerName": { - "type": "string", - "description": "The storage container name." - }, - "settings": { - "$ref": "#/definitions/TextAuthoringProjectSettings", - "description": "The project settings." - }, - "projectName": { - "type": "string", - "description": "The new project name." - }, - "multilingual": { - "type": "boolean", - "description": "Whether the project would be used for multiple languages or not." - }, - "description": { - "type": "string", - "description": "The project description." - }, - "language": { - "type": "string", - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - } - }, - "required": [ - "projectKind", - "storageInputContainerName", - "projectName", - "language" - ] - }, - "TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult": { - "type": "object", - "description": "Represents the document evaluation result for a custom entity recognition project.", - "properties": { - "customEntityRecognitionResult": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult", - "description": "Represents the evaluation prediction for entity recognition." - } - }, - "required": [ - "customEntityRecognitionResult" - ], - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - ], - "x-ms-discriminator-value": "CustomEntityRecognition" - }, - "TextAnalysisAuthoringCustomEntityRecognitionEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation summary for a custom entity recognition project.", - "properties": { - "customEntityRecognitionEvaluation": { - "$ref": "#/definitions/TextAnalysisAuthoringEntityRecognitionEvaluationSummary", - "description": "Contains the data related to extraction evaluation." - } - }, - "required": [ - "customEntityRecognitionEvaluation" - ], - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - ], - "x-ms-discriminator-value": "CustomEntityRecognition" - }, - "TextAnalysisAuthoringCustomHealthcareDocumentEvaluationResult": { - "type": "object", - "description": "Represents the document evaluation result for a custom entity recognition project.", - "properties": { - "customHealthcareResult": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentHealthcareEvaluationResult", - "description": "Represents the evaluation prediction for entity recognition." - } - }, - "required": [ - "customHealthcareResult" - ], - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - ], - "x-ms-discriminator-value": "CustomHealthcare" - }, - "TextAnalysisAuthoringCustomHealthcareEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation summary for a custom health care project.", - "properties": { - "customHealthcareEvaluation": { - "$ref": "#/definitions/TextAnalysisAuthoringEntityRecognitionEvaluationSummary", - "description": "Contains the data related to health care evaluation." - } - }, - "required": [ - "customHealthcareEvaluation" - ], - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - ], - "x-ms-discriminator-value": "CustomHealthcare" - }, - "TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult": { - "type": "object", - "description": "Represents the document evaluation result for a custom multi-label classification project.", - "properties": { - "customMultiLabelClassificationResult": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult", - "description": "Represents the evaluation prediction for multi label classification." - } - }, - "required": [ - "customMultiLabelClassificationResult" - ], - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - ], - "x-ms-discriminator-value": "CustomMultiLabelClassification" - }, - "TextAnalysisAuthoringCustomMultiLabelClassificationEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation summary for a custom multi-label classification project.", - "properties": { - "customMultiLabelClassificationEvaluation": { - "$ref": "#/definitions/TextAnalysisAuthoringMultiLabelClassificationEvaluationSummary", - "description": "Contains the data related to multi label classification evaluation." - } - }, - "required": [ - "customMultiLabelClassificationEvaluation" - ], - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - ], - "x-ms-discriminator-value": "CustomMultiLabelClassification" - }, - "TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult": { - "type": "object", - "description": "Represents the document evaluation result for a custom single-label classification project.", - "properties": { - "customSingleLabelClassificationResult": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult", - "description": "Represents the evaluation prediction for single label classification." - } - }, - "required": [ - "customSingleLabelClassificationResult" - ], - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - ], - "x-ms-discriminator-value": "CustomSingleLabelClassification" - }, - "TextAnalysisAuthoringCustomSingleLabelClassificationEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation summary for a custom single-label classification project.", - "properties": { - "customSingleLabelClassificationEvaluation": { - "$ref": "#/definitions/TextAnalysisAuthoringSingleLabelClassificationEvaluationSummary", - "description": "Contains the data related to single label classification evaluation." - } - }, - "required": [ - "customSingleLabelClassificationEvaluation" - ], - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - ], - "x-ms-discriminator-value": "CustomSingleLabelClassification" - }, - "TextAnalysisAuthoringCustomTextSentimentDocumentEvaluationResult": { - "type": "object", - "description": "Represents the document evaluation result for a custom sentiment project.", - "properties": { - "customTextSentimentResult": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentTextSentimentEvaluationResult", - "description": "Represents the evaluation prediction for text sentiment." - } - }, - "required": [ - "customTextSentimentResult" - ], - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" - } - ], - "x-ms-discriminator-value": "CustomTextSentiment" - }, - "TextAnalysisAuthoringCustomTextSentimentEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation summary for a custom text sentiment project.", - "properties": { - "customTextSentimentEvaluation": { - "$ref": "#/definitions/TextAnalysisAuthoringTextSentimentEvaluationSummary", - "description": "Contains the data related to custom sentiment evaluation." - } - }, - "required": [ - "customTextSentimentEvaluation" - ], - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" - } - ], - "x-ms-discriminator-value": "CustomTextSentiment" - }, - "TextAnalysisAuthoringDeleteDeploymentOptions": { - "type": "object", - "description": "Represents the options for deleting a project deployment.", - "properties": { - "assignedResourceIds": { - "type": "array", - "description": "Represents the resource IDs to delete the deployment from. If not provided, the deployment will be rolled out from all the resources it is deployed to. If provided, it will delete the deployment only from the specified assigned resources, and leave it for the rest.", - "items": { - "type": "string" - } - } - } - }, - "TextAnalysisAuthoringDeploymentDeleteFromResourcesJobState": { - "type": "object", - "description": "Represents the state of an existing delete deployment from specific resources job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "TextAnalysisAuthoringDeploymentJobState": { - "type": "object", - "description": "Represents the state of a deployment job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "TextAnalysisAuthoringDeploymentResource": { - "type": "object", - "description": "Represents an Azure resource assigned to a deployment.", - "properties": { - "resourceId": { - "type": "string", - "description": "Represents the Azure resource Id." - }, - "region": { - "type": "string", - "description": "Represents the resource region." - } - }, - "required": [ - "resourceId", - "region" - ] - }, - "TextAnalysisAuthoringDeploymentResourcesJobState": { - "type": "object", - "description": "Represents the state of a deployment resources job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "TextAnalysisAuthoringDocumentEntityLabelEvaluationResult": { - "type": "object", - "description": "Represents an evaluation result entity label.", - "properties": { - "category": { - "type": "string", - "description": "Represents the entity category." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Represents the entity offset index relative to the original text." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Represents the entity length." - } - }, - "required": [ - "category", - "offset", - "length" - ] - }, - "TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult": { - "type": "object", - "description": "Represents the entity recognition evaluation result for a document.", - "properties": { - "entities": { - "type": "array", - "description": "Represents the document labelled entities.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityRegionEvaluationResult" - } - } - }, - "required": [ - "entities" - ] - }, - "TextAnalysisAuthoringDocumentEntityRegionEvaluationResult": { - "type": "object", - "description": "Represents the evaluation comparison between the expected and predicted entities of a document region.", - "properties": { - "expectedEntities": { - "type": "array", - "description": "Represents the region's expected entity labels.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityLabelEvaluationResult" - } - }, - "predictedEntities": { - "type": "array", - "description": "Represents the region's predicted entity labels.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityLabelEvaluationResult" - } - }, - "regionOffset": { - "type": "integer", - "format": "int32", - "description": "Represents the region offset." - }, - "regionLength": { - "type": "integer", - "format": "int32", - "description": "Represents the region length." - } - }, - "required": [ - "expectedEntities", - "predictedEntities", - "regionOffset", - "regionLength" - ] - }, - "TextAnalysisAuthoringDocumentEvaluationResult": { - "type": "object", - "description": "Represents the evaluation result of a document.", - "properties": { - "projectKind": { - "$ref": "#/definitions/ProjectKind", - "description": "Represents the project kind.", - "readOnly": true - }, - "location": { - "type": "string", - "description": "Represents the document path." - }, - "language": { - "type": "string", - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - } - }, - "discriminator": "projectKind", - "required": [ - "projectKind", - "location", - "language" - ] - }, - "TextAnalysisAuthoringDocumentHealthcareEvaluationResult": { - "type": "object", - "description": "Represents the healthcare evaluation result for a document.", - "properties": { - "entities": { - "type": "array", - "description": "Represents the document labelled entities.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityRegionEvaluationResult" - } - } - }, - "required": [ - "entities" - ] - }, - "TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult": { - "type": "object", - "description": "Represents the comparison between the expected and predicted classes that are result from the evaluation operation.", - "properties": { - "expectedClasses": { - "type": "array", - "description": "Represents the document's expected classes.", - "items": { - "type": "string" - } - }, - "predictedClasses": { - "type": "array", - "description": "Represents the document's predicted classes.", - "items": { - "type": "string" - } - } - }, - "required": [ - "expectedClasses", - "predictedClasses" - ] - }, - "TextAnalysisAuthoringDocumentSentimentLabelEvaluationResult": { - "type": "object", - "description": "Represents an evaluation result Sentiment label.", - "properties": { - "category": { - "$ref": "#/definitions/Sentiment", - "description": "Represents the sentiment category." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Represents the sentiment offset index relative to the original text." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Represents the sentiment length." - } - }, - "required": [ - "category", - "offset", - "length" - ] - }, - "TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult": { - "type": "object", - "description": "Represents the comparison between the expected and predicted class that result from an evaluation operation.", - "properties": { - "expectedClass": { - "type": "string", - "description": "Represents the document's expected class." - }, - "predictedClass": { - "type": "string", - "description": "Represents the document's predicted class." - } - }, - "required": [ - "expectedClass", - "predictedClass" - ] - }, - "TextAnalysisAuthoringDocumentTextSentimentEvaluationResult": { - "type": "object", - "description": "Represents the comparison between the expected and predicted sentiment that result from an evaluation operation.", - "properties": { - "expectedSentimentSpans": { - "type": "array", - "description": "Represents the document's expected sentiment labels.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentSentimentLabelEvaluationResult" - } - }, - "predictedSentimentSpans": { - "type": "array", - "description": "Represents the document's predicted sentiment labels.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDocumentSentimentLabelEvaluationResult" - } - } - }, - "required": [ - "expectedSentimentSpans", - "predictedSentimentSpans" - ] - }, - "TextAnalysisAuthoringEntityEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation summary for an entity.", - "properties": { - "f1": { - "type": "number", - "format": "double", - "description": "Represents the model precision" - }, - "precision": { - "type": "number", - "format": "double", - "description": "Represents the model recall" - }, - "recall": { - "type": "number", - "format": "double", - "description": "Represents the model F1 score" - }, - "truePositiveCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of true positive" - }, - "trueNegativeCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of true negative" - }, - "falsePositiveCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of false positive" - }, - "falseNegativeCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of false negative" - } - }, - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ] - }, - "TextAnalysisAuthoringEntityRecognitionEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation summary for a custom entity recognition project.", - "properties": { - "confusionMatrix": { - "type": "object", - "description": "Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted.", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixRow" - } - }, - "entities": { - "type": "object", - "description": "Represents the entities evaluation", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringEntityEvaluationSummary" - } - }, - "microF1": { - "type": "number", - "format": "float", - "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." - }, - "microPrecision": { - "type": "number", - "format": "float", - "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive." - }, - "microRecall": { - "type": "number", - "format": "float", - "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive." - }, - "macroF1": { - "type": "number", - "format": "float", - "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." - }, - "macroPrecision": { - "type": "number", - "format": "float", - "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive." - }, - "macroRecall": { - "type": "number", - "format": "float", - "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive." - } - }, - "required": [ - "confusionMatrix", - "entities", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ] - }, - "TextAnalysisAuthoringEvaluationJobResult": { - "type": "object", - "properties": { - "evaluationOptions": { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions", - "description": "Represents the options used running the evaluation." - }, - "modelLabel": { - "type": "string", - "description": "Represents trained model label." - }, - "trainingConfigVersion": { - "type": "string", - "description": "Represents training config version." - }, - "percentComplete": { - "type": "integer", - "format": "int32", - "description": "Represents progress percentage." - } - }, - "required": [ - "evaluationOptions", - "modelLabel", - "trainingConfigVersion", - "percentComplete" - ] - }, - "TextAnalysisAuthoringEvaluationJobState": { - "type": "object", - "description": "Represents the state of a evaluation job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "result": { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationJobResult", - "description": "Represents evaluation task detailed result." - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status", - "result" - ] - }, - "TextAnalysisAuthoringEvaluationOptions": { - "type": "object", - "description": "Represents the options used running the evaluation.", - "properties": { - "kind": { - "$ref": "#/definitions/EvaluationKind", - "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage." - }, - "trainingSplitPercentage": { - "type": "integer", - "format": "int32", - "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage." - }, - "testingSplitPercentage": { - "type": "integer", - "format": "int32", - "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage." - } - } - }, - "TextAnalysisAuthoringEvaluationSummary": { - "type": "object", - "description": "Represents the summary for an evaluation operation.", - "properties": { - "projectKind": { - "$ref": "#/definitions/ProjectKind", - "description": "Represents the project type that the evaluation ran on." - }, - "evaluationOptions": { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions", - "description": "Represents the options used running the evaluation." - } - }, - "discriminator": "projectKind", - "required": [ - "projectKind", - "evaluationOptions" - ] - }, - "TextAnalysisAuthoringExportProjectJobState": { - "type": "object", - "description": "Represents the state of an export job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "resultUrl": { - "type": "string", - "description": "The URL to use in order to download the exported project." - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "TextAnalysisAuthoringExportedClass": { - "type": "object", - "description": "Represents a class of an exported project.", - "properties": { - "category": { - "type": "string", - "description": "The class category." - } - } - }, - "TextAnalysisAuthoringExportedCompositeEntity": { - "type": "object", - "description": "Represents an entity in an exported project with composite entities enabled.", - "properties": { - "compositionSetting": { - "$ref": "#/definitions/CompositionSetting", - "description": "The behavior to follow when the entity's components overlap with each other." - }, - "list": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedEntityList", - "description": "The list component of the entity." - }, - "prebuilts": { - "type": "array", - "description": "The prebuilt entities components.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedPrebuiltEntity" - } - }, - "category": { - "type": "string", - "description": "The entity category." - } - } - }, - "TextAnalysisAuthoringExportedCustomAbstractiveSummarizationDocument": { - "type": "object", - "description": "Represents an exported document for a custom abstractive summarization project.", - "properties": { - "summaryLocation": { - "type": "string", - "description": "Represents the summary file location in the blob store container associated with the project." - }, - "location": { - "type": "string", - "description": "The location of the document in the storage." - }, - "language": { - "type": "string", - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - }, - "dataset": { - "type": "string", - "description": "The dataset for this document. Allowed values are 'Train' and 'Test'." - } - }, - "required": [ - "summaryLocation" - ] - }, - "TextAnalysisAuthoringExportedCustomAbstractiveSummarizationProjectAssets": { - "type": "object", - "description": "Represents the exported assets for an abstractive summarization project.", - "properties": { - "documents": { - "type": "array", - "description": "The list of documents belonging to this project.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomAbstractiveSummarizationDocument" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - ], - "x-ms-discriminator-value": "CustomAbstractiveSummarization" - }, - "TextAnalysisAuthoringExportedCustomEntityRecognitionDocument": { - "type": "object", - "description": "Represents an exported document for a custom entity recognition project.", - "properties": { - "entities": { - "type": "array", - "description": "The list of entity labels belonging to the document.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentEntityRegion" - } - }, - "location": { - "type": "string", - "description": "The location of the document in the storage." - }, - "language": { - "type": "string", - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - }, - "dataset": { - "type": "string", - "description": "The dataset for this document. Allowed values are 'Train' and 'Test'." - } - } - }, - "TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets": { - "type": "object", - "description": "Represents the exported assets for a entity recognition project.", - "properties": { - "entities": { - "type": "array", - "description": "The list of entities belonging to the project.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedEntity" - } - }, - "documents": { - "type": "array", - "description": "The list of documents belonging to the project.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomEntityRecognitionDocument" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - ], - "x-ms-discriminator-value": "CustomEntityRecognition" - }, - "TextAnalysisAuthoringExportedCustomHealthcareDocument": { - "type": "object", - "description": "Represents an exported document for a CustomHealthcare project.", - "properties": { - "entities": { - "type": "array", - "description": "The list of entity labels belonging to the document.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentEntityRegion" - } - }, - "location": { - "type": "string", - "description": "The location of the document in the storage." - }, - "language": { - "type": "string", - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - }, - "dataset": { - "type": "string", - "description": "The dataset for this document. Allowed values are 'Train' and 'Test'." - } - } - }, - "TextAnalysisAuthoringExportedCustomHealthcareProjectAssets": { - "type": "object", - "description": "Represents the exported assets for a CustomHealthcare project.", - "properties": { - "entities": { - "type": "array", - "description": "The list of entities belonging to the project.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedCompositeEntity" - } - }, - "documents": { - "type": "array", - "description": "The list of documents belonging to the project.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomHealthcareDocument" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - ], - "x-ms-discriminator-value": "CustomHealthcare" - }, - "TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument": { - "type": "object", - "description": "Represents an exported document of a custom multi-label classification project.", - "properties": { - "classes": { - "type": "array", - "description": "The document classes.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentClass" - } - }, - "location": { - "type": "string", - "description": "The location of the document in the storage." - }, - "language": { - "type": "string", - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - }, - "dataset": { - "type": "string", - "description": "The dataset for this document. Allowed values are 'Train' and 'Test'." - } - } - }, - "TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets": { - "type": "object", - "description": "Represents the exported assets for a custom multi-label classification project.", - "properties": { - "classes": { - "type": "array", - "description": "The list of classes in the project.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedClass" - } - }, - "documents": { - "type": "array", - "description": "The list of documents in the project.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - ], - "x-ms-discriminator-value": "CustomMultiLabelClassification" - }, - "TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument": { - "type": "object", - "description": "Represents an exported document for a custom single-label classification project.", - "properties": { - "class": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentClass", - "description": "The class of the documents." - }, - "location": { - "type": "string", - "description": "The location of the document in the storage." - }, - "language": { - "type": "string", - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - }, - "dataset": { - "type": "string", - "description": "The dataset for this document. Allowed values are 'Train' and 'Test'." - } - } - }, - "TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets": { - "type": "object", - "description": "Represents the exported assets for a single-label classification project.", - "properties": { - "classes": { - "type": "array", - "description": "The list of classes belonging to this project.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedClass" - } - }, - "documents": { - "type": "array", - "description": "The list of documents belonging to this project.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - ], - "x-ms-discriminator-value": "CustomSingleLabelClassification" - }, - "TextAnalysisAuthoringExportedCustomTextSentimentDocument": { - "type": "object", - "description": "Represents an exported document for a custom text sentiment project.", - "properties": { - "sentimentSpans": { - "type": "array", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentSentimentLabel" - } - }, - "location": { - "type": "string", - "description": "The location of the document in the storage." - }, - "language": { - "type": "string", - "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - }, - "dataset": { - "type": "string", - "description": "The dataset for this document. Allowed values are 'Train' and 'Test'." - } - } - }, - "TextAnalysisAuthoringExportedCustomTextSentimentProjectAssets": { - "type": "object", - "description": "Represents the exported assets for a custom text sentiment project.", - "properties": { - "documents": { - "type": "array", - "description": "The list of documents belonging to the project.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomTextSentimentDocument" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" - } - ], - "x-ms-discriminator-value": "CustomTextSentiment" - }, - "TextAnalysisAuthoringExportedDocumentClass": { - "type": "object", - "description": "Represents a classification label for a document.", - "properties": { - "category": { - "type": "string" - } - } - }, - "TextAnalysisAuthoringExportedDocumentEntityLabel": { - "type": "object", - "description": "Represents an entity label for a document.", - "properties": { - "category": { - "type": "string", - "description": "The entity category." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text." - } - } - }, - "TextAnalysisAuthoringExportedDocumentEntityRegion": { - "type": "object", - "description": "Represents a region in a document for entity labeling.", - "properties": { - "regionOffset": { - "type": "integer", - "format": "int32", - "description": "Start position for the region." - }, - "regionLength": { - "type": "integer", - "format": "int32", - "description": "Length for the region text." - }, - "labels": { - "type": "array", - "description": "The list of entity labels belonging to this region.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentEntityLabel" - } - } - } - }, - "TextAnalysisAuthoringExportedDocumentSentimentLabel": { - "type": "object", - "description": "Represents an entity label for a document.", - "properties": { - "category": { - "$ref": "#/definitions/Sentiment", - "description": "The sentiment category." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the sentiment text." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the sentiment text." - } - } - }, - "TextAnalysisAuthoringExportedEntity": { - "type": "object", - "description": "Represents an entity in an exported project.", - "properties": { - "category": { - "type": "string", - "description": "The entity category." - } - } - }, - "TextAnalysisAuthoringExportedEntityList": { - "type": "object", - "description": "Represents a list component of an entity.", - "properties": { - "sublists": { - "type": "array", - "description": "The sub-lists of the list component.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedEntitySublist" - } - } - } - }, - "TextAnalysisAuthoringExportedEntityListSynonym": { - "type": "object", - "description": "Represents a list of synonyms inside a list component", - "properties": { - "language": { - "type": "string", - "description": "Represents the language of the synonyms. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - }, - "values": { - "type": "array", - "description": "The list of synonyms.", - "items": { - "type": "string" - } - } - } - }, - "TextAnalysisAuthoringExportedEntitySublist": { - "type": "object", - "description": "Represents a sub-list inside a list component.", - "properties": { - "listKey": { - "type": "string", - "description": "The key of the sub-list." - }, - "synonyms": { - "type": "array", - "description": "The phrases of that correspond to the sub-list.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedEntityListSynonym" - } - } - } - }, - "TextAnalysisAuthoringExportedModelJobState": { - "type": "object", - "description": "Represents the state of a job to create or updated an exported model.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "TextAnalysisAuthoringExportedModelManifest": { - "type": "object", - "description": "Represents the properties for the exported model manifest.", - "properties": { - "modelFiles": { - "type": "array", - "description": "The model files belonging to this model.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringModelFile" - } - } - }, - "required": [ - "modelFiles" - ] - }, - "TextAnalysisAuthoringExportedModelOptions": { - "type": "object", - "description": "Represents the options for creating or replacing an exported model.", - "properties": { - "trainedModelLabel": { - "type": "string", - "description": "The trained model label." - } - }, - "required": [ - "trainedModelLabel" - ] - }, - "TextAnalysisAuthoringExportedPrebuiltEntity": { - "type": "object", - "description": "Represents an exported prebuilt entity component", - "properties": { - "category": { - "type": "string", - "description": "The prebuilt entity category." - } - }, - "required": [ - "category" - ] - }, - "TextAnalysisAuthoringExportedProject": { - "type": "object", - "description": "Represents an exported project.", - "properties": { - "projectFileVersion": { - "type": "string", - "description": "The version of the exported file." - }, - "stringIndexType": { - "$ref": "#/definitions/StringIndexType", - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets." - }, - "metadata": { - "$ref": "#/definitions/TextAnalysisAuthoringCreateProjectOptions", - "description": "Represents the project metadata." - }, - "assets": { - "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets", - "description": "Represents the project assets." - } - }, - "required": [ - "projectFileVersion", - "stringIndexType", - "metadata" - ] - }, - "TextAnalysisAuthoringExportedProjectAssets": { - "type": "object", - "description": "Represents the assets of an exported project.", - "properties": { - "projectKind": { - "$ref": "#/definitions/ProjectKind" - } - }, - "discriminator": "projectKind", - "required": [ - "projectKind" - ] - }, - "TextAnalysisAuthoringExportedTrainedModel": { - "type": "object", - "description": "Represents an exported trained model.", - "properties": { - "exportedModelName": { - "type": "string", - "description": "The exported model name.", - "readOnly": true - }, - "modelId": { - "type": "string", - "description": "The model ID." - }, - "lastTrainedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last trained date time of the model." - }, - "lastExportedModelDateTime": { - "type": "string", - "format": "date-time", - "description": "The last exported date time of the model." - }, - "modelExpirationDate": { - "type": "string", - "format": "date", - "description": "The model expiration date." - }, - "modelTrainingConfigVersion": { - "type": "string", - "description": "The model training config version." - } - }, - "required": [ - "exportedModelName", - "modelId", - "lastTrainedDateTime", - "lastExportedModelDateTime", - "modelExpirationDate", - "modelTrainingConfigVersion" - ] - }, - "TextAnalysisAuthoringImportProjectJobState": { - "type": "object", - "description": "Represents the state of an import job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "TextAnalysisAuthoringLoadSnapshotJobState": { - "type": "object", - "description": "Represents the state of loading a snapshot job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "TextAnalysisAuthoringModelFile": { - "type": "object", - "description": "Represents the properties for the model file.", - "properties": { - "name": { - "type": "string", - "description": "The name of the file." - }, - "contentUri": { - "type": "string", - "format": "uri", - "description": "The URI to retrieve the content of the file." - } - }, - "required": [ - "name", - "contentUri" - ] - }, - "TextAnalysisAuthoringMultiLabelClassEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation summary of a class in a multi-label classification project.", - "properties": { - "f1": { - "type": "number", - "format": "double", - "description": "Represents the model precision" - }, - "precision": { - "type": "number", - "format": "double", - "description": "Represents the model recall" - }, - "recall": { - "type": "number", - "format": "double", - "description": "Represents the model F1 score" - }, - "truePositiveCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of true positive" - }, - "trueNegativeCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of true negative" - }, - "falsePositiveCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of false positive" - }, - "falseNegativeCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of false negative" - } - }, - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ] - }, - "TextAnalysisAuthoringMultiLabelClassificationEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation summary for a multi-label classification project.", - "properties": { - "classes": { - "type": "object", - "description": "Represents the classes evaluation", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringMultiLabelClassEvaluationSummary" - } - }, - "microF1": { - "type": "number", - "format": "float", - "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." - }, - "microPrecision": { - "type": "number", - "format": "float", - "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive." - }, - "microRecall": { - "type": "number", - "format": "float", - "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive." - }, - "macroF1": { - "type": "number", - "format": "float", - "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." - }, - "macroPrecision": { - "type": "number", - "format": "float", - "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive." - }, - "macroRecall": { - "type": "number", - "format": "float", - "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive." - } - }, - "required": [ - "classes", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ] - }, - "TextAnalysisAuthoringPrebuiltEntity": { - "type": "object", - "description": "Represents a supported prebuilt entity.", - "properties": { - "category": { - "type": "string", - "description": "The prebuilt entity category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description." - }, - "examples": { - "type": "string", - "description": "English examples for the entity." - } - }, - "required": [ - "category", - "description", - "examples" - ] - }, - "TextAnalysisAuthoringProjectDeletionJobState": { - "type": "object", - "description": "Represents the state of a project deletion job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "TextAnalysisAuthoringProjectDeployment": { - "type": "object", - "description": "Represents a project deployment.", - "properties": { - "deploymentName": { - "type": "string", - "description": "Represents deployment name.", - "readOnly": true - }, - "modelId": { - "type": "string", - "description": "Represents deployment modelId." - }, - "lastTrainedDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents deployment last trained time." - }, - "lastDeployedDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents deployment last deployed time." - }, - "deploymentExpirationDate": { - "type": "string", - "format": "date", - "description": "Represents deployment expiration date in the runtime." - }, - "modelTrainingConfigVersion": { - "type": "string", - "description": "Represents model training config version." - }, - "assignedResources": { - "type": "array", - "description": "Represents the metadata of the assigned Azure resources.", - "items": { - "$ref": "#/definitions/TextAnalysisAuthoringDeploymentResource" - } - } - }, - "required": [ - "deploymentName", - "modelId", - "lastTrainedDateTime", - "lastDeployedDateTime", - "deploymentExpirationDate", - "modelTrainingConfigVersion", - "assignedResources" - ] - }, - "TextAnalysisAuthoringProjectMetadata": { - "type": "object", - "description": "Represents the metadata of a project.", - "properties": { - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents the project creation datetime." - }, - "lastModifiedDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents the project last modification datetime." - }, - "lastTrainedDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents the project last training datetime." - }, - "lastDeployedDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents the project last deployment datetime." - }, - "projectKind": { - "$ref": "#/definitions/ProjectKind", - "description": "The project kind." - }, - "storageInputContainerName": { - "type": "string", - "description": "The storage container name." - }, - "settings": { - "$ref": "#/definitions/TextAuthoringProjectSettings", - "description": "The project settings." - }, - "projectName": { - "type": "string", - "description": "The new project name.", - "readOnly": true - }, - "multilingual": { - "type": "boolean", - "description": "Whether the project would be used for multiple languages or not." - }, - "description": { - "type": "string", - "description": "The project description." - }, - "language": { - "type": "string", - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - } - }, - "required": [ - "createdDateTime", - "lastModifiedDateTime", - "projectKind", - "storageInputContainerName", - "projectName", - "language" - ] - }, - "TextAnalysisAuthoringProjectTrainedModel": { - "type": "object", - "description": "Represents a trained model.", - "properties": { - "label": { - "type": "string", - "description": "The trained model label.", - "readOnly": true - }, - "modelId": { - "type": "string", - "description": "The model ID." - }, - "lastTrainedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last trained date time of the model." - }, - "lastTrainingDurationInSeconds": { - "type": "integer", - "format": "int32", - "description": "The duration of the model's last training request in seconds." - }, - "modelExpirationDate": { - "type": "string", - "format": "date", - "description": "The model expiration date." - }, - "modelTrainingConfigVersion": { - "type": "string", - "description": "The model training config version." - }, - "hasSnapshot": { - "type": "boolean", - "description": "The flag to indicate if the trained model has a snapshot ready." - } - }, - "required": [ - "label", - "modelId", - "lastTrainedDateTime", - "lastTrainingDurationInSeconds", - "modelExpirationDate", - "modelTrainingConfigVersion", - "hasSnapshot" - ] - }, - "TextAnalysisAuthoringResourceMetadata": { - "type": "object", - "description": "Represents metadata for the Azure resource..", - "properties": { - "azureResourceId": { - "type": "string", - "description": "Represents the Azure resource ID." - }, - "customDomain": { - "type": "string", - "description": "Represents the Azure resource custom domain." - }, - "region": { - "type": "string", - "description": "Represents the Azure resource region." - } - }, - "required": [ - "azureResourceId", - "customDomain", - "region" - ] - }, - "TextAnalysisAuthoringSentimentEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation summary for a sentiment in a custom sentiment project.", - "properties": { - "f1": { - "type": "number", - "format": "double", - "description": "Represents the model precision" - }, - "precision": { - "type": "number", - "format": "double", - "description": "Represents the model recall" - }, - "recall": { - "type": "number", - "format": "double", - "description": "Represents the model F1 score" - }, - "truePositiveCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of true positive" - }, - "trueNegativeCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of true negative" - }, - "falsePositiveCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of false positive" - }, - "falseNegativeCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of false negative" - } - }, - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ] - }, - "TextAnalysisAuthoringSingleLabelClassEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation summary for a class in a single-label classification project.", - "properties": { - "f1": { - "type": "number", - "format": "double", - "description": "Represents the model precision" - }, - "precision": { - "type": "number", - "format": "double", - "description": "Represents the model recall" - }, - "recall": { - "type": "number", - "format": "double", - "description": "Represents the model F1 score" - }, - "truePositiveCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of true positive" - }, - "trueNegativeCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of true negative" - }, - "falsePositiveCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of false positive" - }, - "falseNegativeCount": { - "type": "integer", - "format": "int32", - "description": "Represents the count of false negative" - } - }, - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ] - }, - "TextAnalysisAuthoringSingleLabelClassificationEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation summary for a custom single-label classification project.", - "properties": { - "confusionMatrix": { - "type": "object", - "description": "Represents the confusion matrix between two classes (the two classes can be the same). The matrix is between the class that was labelled and the class that was predicted.", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixRow" - } - }, - "classes": { - "type": "object", - "description": "Represents the classes evaluation", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringSingleLabelClassEvaluationSummary" - } - }, - "microF1": { - "type": "number", - "format": "float", - "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." - }, - "microPrecision": { - "type": "number", - "format": "float", - "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive." - }, - "microRecall": { - "type": "number", - "format": "float", - "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive." - }, - "macroF1": { - "type": "number", - "format": "float", - "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." - }, - "macroPrecision": { - "type": "number", - "format": "float", - "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive." - }, - "macroRecall": { - "type": "number", - "format": "float", - "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive." - } - }, - "required": [ - "confusionMatrix", - "classes", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ] - }, - "TextAnalysisAuthoringSpanSentimentEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation summary for a custom sentiment project.", - "properties": { - "confusionMatrix": { - "type": "object", - "description": "Represents the confusion matrix between two sentiments (the two sentiments can be the same). The matrix is between the sentiment that was labelled and the sentiment that was predicted.", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixRow" - } - }, - "sentiments": { - "type": "object", - "description": "Represents the sentiment evaluation", - "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringSentimentEvaluationSummary" - } - }, - "microF1": { - "type": "number", - "format": "float", - "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." - }, - "microPrecision": { - "type": "number", - "format": "float", - "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive." - }, - "microRecall": { - "type": "number", - "format": "float", - "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive." - }, - "macroF1": { - "type": "number", - "format": "float", - "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." - }, - "macroPrecision": { - "type": "number", - "format": "float", - "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive." - }, - "macroRecall": { - "type": "number", - "format": "float", - "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive." - } - }, - "required": [ - "confusionMatrix", - "sentiments", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ] - }, - "TextAnalysisAuthoringSubTrainingJobState": { - "type": "object", - "description": "Represents the detailed state of a training sub-operation.", - "properties": { - "percentComplete": { - "type": "integer", - "format": "int32", - "description": "Represents progress percentage." - }, - "startDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents the start date time." - }, - "endDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents the end date time." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "Represents the status of the sub-operation." - } - }, - "required": [ - "percentComplete", - "status" - ] - }, - "TextAnalysisAuthoringSupportedLanguage": { - "type": "object", - "description": "Represents a supported language.", - "properties": { - "languageName": { - "type": "string", - "description": "The language name.", - "readOnly": true - }, - "languageCode": { - "type": "string", - "description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." - } - }, - "required": [ - "languageName", - "languageCode" - ] - }, - "TextAnalysisAuthoringSwapDeploymentsJobState": { - "type": "object", - "description": "Represents the state of a deployment job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ] - }, - "TextAnalysisAuthoringSwapDeploymentsOptions": { - "type": "object", - "description": "Represents the options for swapping two deployments together.", - "properties": { - "firstDeploymentName": { - "type": "string", - "description": "Represents the first deployment name." - }, - "secondDeploymentName": { - "type": "string", - "description": "Represents the second deployment name." - } - }, - "required": [ - "firstDeploymentName", - "secondDeploymentName" - ] - }, - "TextAnalysisAuthoringTextSentimentEvaluationSummary": { - "type": "object", - "description": "Represents the evaluation summary for a custom text sentiment project.", - "properties": { - "spanSentimentsEvaluation": { - "$ref": "#/definitions/TextAnalysisAuthoringSpanSentimentEvaluationSummary", - "description": "Represents evaluation of span level sentiments" - }, - "microF1": { - "type": "number", - "format": "float", - "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." - }, - "microPrecision": { - "type": "number", - "format": "float", - "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive." - }, - "microRecall": { - "type": "number", - "format": "float", - "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive." - }, - "macroF1": { - "type": "number", - "format": "float", - "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." - }, - "macroPrecision": { - "type": "number", - "format": "float", - "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive." - }, - "macroRecall": { - "type": "number", - "format": "float", - "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive." - } - }, - "required": [ - "spanSentimentsEvaluation", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ] - }, - "TextAnalysisAuthoringTrainingConfigVersion": { - "type": "object", - "description": "Represents a training config version.", - "properties": { - "trainingConfigVersion": { - "type": "string", - "description": "Represents the version of the config.", - "readOnly": true - }, - "modelExpirationDate": { - "type": "string", - "format": "date", - "description": "Represents the training config version expiration date." - } - }, - "required": [ - "trainingConfigVersion", - "modelExpirationDate" - ] - }, - "TextAnalysisAuthoringTrainingJobOptions": { - "type": "object", - "description": "Represents the options for starting a new training job.", - "properties": { - "modelLabel": { - "type": "string", - "description": "Represents the output model label." - }, - "trainingConfigVersion": { - "type": "string", - "description": "Represents training config version." - }, - "evaluationOptions": { - "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions", - "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20." - } - }, - "required": [ - "modelLabel", - "trainingConfigVersion" - ] - }, - "TextAnalysisAuthoringTrainingJobResult": { - "type": "object", - "description": "Represents the output of a training job.", - "properties": { - "modelLabel": { - "type": "string", - "description": "Represents trained model label." - }, - "trainingConfigVersion": { - "type": "string", - "description": "Represents training config version." - }, - "trainingStatus": { - "$ref": "#/definitions/TextAnalysisAuthoringSubTrainingJobState", - "description": "Represents model train status." - }, - "evaluationStatus": { - "$ref": "#/definitions/TextAnalysisAuthoringSubTrainingJobState", - "description": "Represents model evaluation status." - }, - "estimatedEndDateTime": { - "type": "string", - "format": "date-time", - "description": "Represents the estimate end date time for training and evaluation." - } - }, - "required": [ - "modelLabel", - "trainingConfigVersion", - "trainingStatus" - ] - }, - "TextAnalysisAuthoringTrainingJobState": { - "type": "object", - "description": "Represents the state of a training job.", - "properties": { - "jobId": { - "type": "string", - "description": "The job ID.", - "readOnly": true - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The creation date time of the job." - }, - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "The last date time the job was updated." - }, - "expirationDateTime": { - "type": "string", - "format": "date-time", - "description": "The expiration date time of the job." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The job status." - }, - "warnings": { - "type": "array", - "description": "The warnings that were encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "errors": { - "type": "array", - "description": "The errors encountered while executing the job.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - } - }, - "result": { - "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobResult", - "description": "Represents training tasks detailed result." - } - }, - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status", - "result" - ] - }, - "TextAnalysisAuthoringUnassignDeploymentResourcesOptions": { - "type": "object", - "description": "Represents the options to unassign Azure resources from a project.", - "properties": { - "assignedResourceIds": { - "type": "array", - "description": "Represents the assigned resource IDs to be unassigned.", - "items": { - "type": "string" - } - } - }, - "required": [ - "assignedResourceIds" - ] - }, - "TextAuthoringProjectSettings": { - "type": "object", - "description": "Represents the settings used to define the project behavior.", - "properties": { - "confidenceThreshold": { - "type": "number", - "format": "float", - "description": "The threshold of the class with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive." - }, - "amlProjectPath": { - "type": "string", - "description": "The path to the AML connected project." - }, - "isLabelingLocked": { - "type": "boolean", - "description": "Indicates whether the labeling experience can be modified or not." - }, - "runGptPredictions": { - "type": "boolean", - "description": "Indicates whether to run GPT predictions or not." - }, - "gptPredictiveLookahead": { - "type": "integer", - "format": "int32", - "description": "The predictive lookahead for GPT predictions that is specified by the user." - } - } - } - }, - "parameters": { - "Azure.Core.Foundations.ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for this operation.", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "x-ms-client-name": "apiVersion" - }, - "Azure.Core.MaxPageSizeQueryParameter": { - "name": "maxpagesize", - "in": "query", - "description": "The maximum number of result items per page.", - "required": false, - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "Azure.Core.SkipQueryParameter": { - "name": "skip", - "in": "query", - "description": "The number of result items to skip.", - "required": false, - "type": "integer", - "format": "int32", - "default": 0, - "x-ms-parameter-location": "method" - }, - "Azure.Core.TopQueryParameter": { - "name": "top", - "in": "query", - "description": "The number of result items to return.", - "required": false, - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "ProjectKindQueryParameter": { - "name": "projectKind", - "in": "query", - "description": "The project kind, default value is CustomSingleLabelClassification.", - "required": false, - "type": "string", - "enum": [ - "CustomSingleLabelClassification", - "CustomMultiLabelClassification", - "CustomEntityRecognition", - "CustomAbstractiveSummarization", - "CustomHealthcare", - "CustomTextSentiment" - ], - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "name": "CustomSingleLabelClassification", - "value": "CustomSingleLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B." - }, - { - "name": "CustomMultiLabelClassification", - "value": "CustomMultiLabelClassification", - "description": "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C." - }, - { - "name": "CustomEntityRecognition", - "value": "CustomEntityRecognition", - "description": "For building an extraction model to identify your domain categories using your own data." - }, - { - "name": "CustomAbstractiveSummarization", - "value": "CustomAbstractiveSummarization", - "description": "For building an abstractive summarization models which are able to summarize long documents." - }, - { - "name": "CustomHealthcare", - "value": "CustomHealthcare", - "description": "For building an text analytics for health model to identify your health domain data." - }, - { - "name": "CustomTextSentiment", - "value": "CustomTextSentiment", - "description": "For building a sentiment models which are able to extract sentiment for long documents." - } - ] - }, - "x-ms-parameter-location": "method", - "x-ms-client-name": "ProjectKind" - }, - "StringIndexTypeQueryParameter": { - "name": "stringIndexType", - "in": "query", - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "required": true, - "type": "string", - "enum": [ - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "name": "Utf16CodeUnit", - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzetext.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzetext.json deleted file mode 100644 index 0fa08dd39ea3..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzetext.json +++ /dev/null @@ -1,4913 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Text Analysis", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/azure/cognitive-services/language-service/overview.0", - "version": "2023-04-15-preview" - }, - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" - } - }, - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://cognitiveservices.azure.com/.default" - ] - }, - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/:analyze-text": { - "post": { - "summary": "Request text analysis over a collection of documents.", - "description": "Submit a collection of text documents for analysis. Specify a single unique task to be executed immediately.", - "operationId": "AnalyzeText", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/ShowStats" - }, - { - "description": "Collection of documents to analyze and a single task to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeTextTask" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "A successful call result", - "schema": { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Entity Linking Request": { - "$ref": "./examples/text/SuccessfulEntityLinkingRequest.json" - }, - "Successful Entity Recognition Request": { - "$ref": "./examples/text/SuccessfulEntityRecognitionRequest.json" - }, - "Successful Entity Recognition Inclusion Request": { - "$ref": "./examples/text/SuccessfulEntityRecognitionInclusionRequest.json" - }, - "Successful Entity Recognition Exclusion Request": { - "$ref": "./examples/text/SuccessfulEntityRecognitionExclusionRequest.json" - }, - "Successful Entity Recognition Overlap Policy Request": { - "$ref": "./examples/text/SuccessfulEntityRecognitionOverlapPolicy.json" - }, - "Successful Key Phrase Extraction Request": { - "$ref": "./examples/text/SuccessfulKeyPhraseExtractionRequest.json" - }, - "Successful PII Entity Recognition Request": { - "$ref": "./examples/text/SuccessfulPiiEntityRecognitionRequest.json" - }, - "Successful PII Entity Recognition Redaction Request": { - "$ref": "./examples/text/SuccessfulPiiEntityRecognitionRedactionRequest.json" - }, - "Successful PII Entity Recognition Exclusion Request": { - "$ref": "./examples/text/SuccessfulPiiEntityRecognitionExclusionRequest.json" - }, - "Successful Language Detection Request": { - "$ref": "./examples/text/SuccessfulLanguageDetectionRequest.json" - }, - "Successful Sentiment Analysis Request": { - "$ref": "./examples/text/SuccessfulSentimentAnalysisRequest.json" - }, - "Successful Dynamic Classification Request": { - "$ref": "./examples/text/SuccessfuDynamicClassificationRequest.json" - } - } - } - }, - "/analyze-text/jobs": { - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "description": "Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.", - "operationId": "AnalyzeText_SubmitJob", - "summary": "Submit text analysis job", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Collection of documents to analyze and one or more tasks to execute.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/AnalyzeTextJobsInput" - }, - "required": true - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Submit Analysis Job Request": { - "$ref": "./examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json" - }, - "Successful Healthcare Post Request": { - "$ref": "./examples/text/SuccessfulHealthcarePostRequest.json" - }, - "Successful Custom Healthcare Post Request": { - "$ref": "./examples/text/SuccessfulCustomHealthcarePostRequest.json" - }, - "Successful Submit Abstractive Summarization Task": { - "$ref": "./examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.json" - }, - "Successful Submit Custom Abstractive Summarization Task": { - "$ref": "./examples/text/SuccessfulCustomAbstractiveSummarizationTaskSubmit.json" - }, - "Successful Healthcare DocumentType Post Request": { - "$ref": "./examples/text/SuccessfulHealthcareDocumentTypePostRequest.json" - }, - "Successful Custom Sentiment Analysis Post Request": { - "$ref": "./examples/text/SuccessfulCustomSentimentAnalysisTaskSubmit.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/analyze-text/jobs/{jobId}": { - "get": { - "produces": [ - "application/json" - ], - "description": "Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are succeeded, the job will transition to the succeeded state and results will be available for each task.", - "operationId": "AnalyzeText_JobStatus", - "summary": "Get analysis status and results", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/JobId" - }, - { - "$ref": "common.json#/parameters/ShowStats" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - } - ], - "responses": { - "200": { - "description": "Analysis job status and metadata.", - "schema": { - "$ref": "#/definitions/AnalyzeTextJobState" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Get Text Analysis Job Status Request": { - "$ref": "./examples/text/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json" - }, - "Successful Get Text Analysis Health Request": { - "$ref": "./examples/text/SuccessfulHealthcareTaskStatusRequest.json" - }, - "Successful Get Text Analysis Custom Health Request": { - "$ref": "./examples/text/SuccessfulCustomHealthcareTaskStatusRequest.json" - }, - "Successful Get Abstractive Summarization Result": { - "$ref": "./examples/text/SuccessfulAbstractiveSummarizationTaskResult.json" - }, - "Successful Get Custom Abstractive Summarization Result": { - "$ref": "./examples/text/SuccessfulCustomAbstractiveSummarizationTaskResult.json" - }, - "Successful Get Text Analysis Health DocumentType Request": { - "$ref": "./examples/text/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json" - }, - "Successful Get Text Analysis Custom Sentiment Analysis Request": { - "$ref": "./examples/text/SuccessfulCustomSentimentAnalysisTaskStatusRequest.json" - } - } - } - }, - "/analyze-text/jobs/{jobId}:cancel": { - "post": { - "produces": [ - "application/json" - ], - "description": "Cancel a long-running Text Analysis job.", - "operationId": "AnalyzeText_CancelJob", - "summary": "Cancel a long-running Text Analysis job", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/JobId" - } - ], - "responses": { - "202": { - "description": "Cancel Job request has been received.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Job Delete Request": { - "$ref": "./examples/text/SuccessfulAnalyzeTextJobsCancelRequest.json" - } - }, - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "AnalyzeTextTaskKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis tasks.", - "enum": [ - "SentimentAnalysis", - "EntityRecognition", - "PiiEntityRecognition", - "KeyPhraseExtraction", - "LanguageDetection", - "EntityLinking", - "DynamicClassification" - ], - "x-ms-enum": { - "name": "AnalyzeTextTaskKind", - "modelAsString": true - } - }, - "AnalyzeTextLROTaskKind": { - "type": "string", - "description": "Enumeration of supported long-running Text Analysis tasks.", - "enum": [ - "SentimentAnalysis", - "EntityRecognition", - "PiiEntityRecognition", - "KeyPhraseExtraction", - "EntityLinking", - "Healthcare", - "CustomHealthcare", - "ExtractiveSummarization", - "CustomEntityRecognition", - "CustomSingleLabelClassification", - "CustomMultiLabelClassification", - "AbstractiveSummarization", - "CustomSentimentAnalysis", - "CustomAbstractiveSummarization" - ], - "x-ms-enum": { - "name": "AnalyzeTextLROTaskKind", - "modelAsString": true - } - }, - "AnalyzeTextTaskResultsKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis task results.", - "enum": [ - "SentimentAnalysisResults", - "EntityRecognitionResults", - "PiiEntityRecognitionResults", - "KeyPhraseExtractionResults", - "LanguageDetectionResults", - "EntityLinkingResults", - "DynamicClassificationResults" - ], - "x-ms-enum": { - "name": "AnalyzeTextTaskResultsKind", - "modelAsString": true - } - }, - "AnalyzeTextLROResultsKind": { - "type": "string", - "description": "Enumeration of supported Text Analysis long-running operation task results.", - "enum": [ - "SentimentAnalysisLROResults", - "EntityRecognitionLROResults", - "PiiEntityRecognitionLROResults", - "KeyPhraseExtractionLROResults", - "EntityLinkingLROResults", - "HealthcareLROResults", - "CustomHealthcareLROResults", - "ExtractiveSummarizationLROResults", - "CustomEntityRecognitionLROResults", - "CustomSingleLabelClassificationLROResults", - "CustomMultiLabelClassificationLROResults", - "AbstractiveSummarizationLROResults", - "CustomSentimentAnalysisLROResults", - "CustomAbstractiveSummarizationLROResults" - ], - "x-ms-enum": { - "name": "AnalyzeTextLROResultsKind", - "modelAsString": true - } - }, - "MultiLanguageAnalysisInput": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/definitions/MultiLanguageInput" - } - } - } - }, - "LanguageDetectionAnalysisInput": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/definitions/LanguageInput" - } - } - } - }, - "AnalyzeTextTask": { - "type": "object", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextTaskKind" - } - } - }, - "AnalyzeTextLROTask": { - "type": "object", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextLROTaskKind" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/TaskIdentifier" - } - ] - }, - "AnalyzeTextTaskResult": { - "type": "object", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextTaskResultsKind" - } - } - }, - "AnalyzeTextEntityLinkingInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/EntityLinkingTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "EntityLinking" - }, - "AnalyzeTextEntityRecognitionInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/EntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "EntityRecognition" - }, - "AnalyzeTextKeyPhraseExtractionInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/KeyPhraseTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "KeyPhraseExtraction" - }, - "AnalyzeTextPiiEntitiesRecognitionInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/PiiTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "PiiEntityRecognition" - }, - "AnalyzeTextLanguageDetectionInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/LanguageDetectionAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/LanguageDetectionTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "LanguageDetection" - }, - "AnalyzeTextSentimentAnalysisInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/SentimentAnalysisTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "SentimentAnalysis" - }, - "AnalyzeTextDynamicClassificationInput": { - "type": "object", - "properties": { - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "parameters": { - "$ref": "#/definitions/DynamicClassificationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTask" - } - ], - "x-ms-discriminator-value": "DynamicClassification" - }, - "AnalyzeTextJobsInput": { - "type": "object", - "properties": { - "displayName": { - "description": "Optional display name for the analysis job.", - "type": "string" - }, - "defaultLanguage": { - "description": "Default language to use for records requesting automatic language detection.", - "type": "string" - }, - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "tasks": { - "description": "The set of tasks to execute on the input documents.", - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - } - }, - "required": [ - "analysisInput", - "tasks" - ] - }, - "CustomEntitiesTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Entities task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/CustomTaskParameters" - } - ] - }, - "CustomEntitiesLROTask": { - "type": "object", - "description": "Use custom models to ease the process of information extraction from unstructured documents like contracts or financial documents", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomEntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomEntityRecognition" - }, - "CustomEntitiesResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/EntitiesDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/CustomResult" - } - ], - "required": [ - "documents" - ] - }, - "CustomSingleLabelClassificationTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Single Classification task.", - "allOf": [ - { - "$ref": "common.json#/definitions/CustomTaskParameters" - } - ] - }, - "CustomSingleLabelClassificationLROTask": { - "type": "object", - "description": "Use custom models to classify text into single label taxonomy", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomSingleLabelClassificationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomSingleLabelClassification" - }, - "CustomLabelClassificationResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/ClassificationDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/CustomResult" - } - ], - "required": [ - "documents" - ] - }, - "ClassificationResult": { - "type": "object", - "required": [ - "category", - "confidenceScore" - ], - "properties": { - "category": { - "type": "string", - "description": "Classification type." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the recognized class." - } - } - }, - "CustomMultiLabelClassificationTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Multi Classification task.", - "allOf": [ - { - "$ref": "common.json#/definitions/CustomTaskParameters" - } - ] - }, - "CustomMultiLabelClassificationLROTask": { - "type": "object", - "description": "Use custom models to classify text into multi label taxonomy", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomMultiLabelClassificationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomMultiLabelClassification" - }, - "ClassificationDocumentResult": { - "type": "object", - "properties": { - "class": { - "type": "array", - "items": { - "$ref": "#/definitions/ClassificationResult" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "class" - ] - }, - "DynamicClassificationDocumentResult": { - "type": "object", - "properties": { - "classifications": { - "type": "array", - "items": { - "$ref": "#/definitions/ClassificationResult" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "classifications" - ] - }, - "HealthcareTaskParameters": { - "type": "object", - "description": "Supported parameters for a Healthcare task.", - "properties": { - "fhirVersion": { - "type": "string", - "description": "The FHIR Spec version that the result will use to format the fhirBundle. For additional information see https://www.hl7.org/fhir/overview.html.", - "enum": [ - "4.0.1" - ], - "x-ms-enum": { - "name": "fhirVersion", - "modelAsString": true - } - }, - "documentType": { - "x-ms-enum": { - "name": "healthcareDocumentType", - "modelAsString": true - }, - "type": "string", - "description": "Document type that can be provided as input for Fhir Documents. Expect to have fhirVersion provided when used. Behavior of using None enum is the same as not using the documentType parameter.", - "enum": [ - "None", - "ClinicalTrial", - "DischargeSummary", - "ProgressNote", - "HistoryAndPhysical", - "Consult", - "Imaging", - "Pathology", - "ProcedureNote" - ] - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "CustomHealthcareTaskParameters": { - "type": "object", - "description": "Supported parameters for a custom Healthcare task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/CustomTaskParameters" - } - ] - }, - "HealthcareLROTask": { - "type": "object", - "properties": { - "parameters": { - "$ref": "#/definitions/HealthcareTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "Healthcare" - }, - "CustomHealthcareLROTask": { - "type": "object", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomHealthcareTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomHealthcare" - }, - "HealthcareResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "CustomHealthcareResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomHealthcareEntitiesDocumentResultWithDocumentDetectedLanguage" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/CustomResult" - } - ], - "required": [ - "documents" - ] - }, - "HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthcareEntitiesDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - }, - "CustomHealthcareEntitiesDocumentResultWithDocumentDetectedLanguage": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CustomHealthcareEntitiesDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - }, - "HealthcareEntitiesDocumentResult": { - "type": "object", - "properties": { - "entities": { - "description": "Healthcare entities.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareEntity" - } - }, - "relations": { - "type": "array", - "description": "Healthcare entity relations.", - "items": { - "$ref": "#/definitions/HealthcareRelation" - } - }, - "fhirBundle": { - "type": "object", - "description": "JSON bundle containing a FHIR compatible object for consumption in other Healthcare tools. For additional information see https://www.hl7.org/fhir/overview.html.", - "additionalProperties": {} - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "entities", - "relations" - ] - }, - "CustomHealthcareEntitiesDocumentResult": { - "type": "object", - "properties": { - "entities": { - "description": "Healthcare entities.", - "type": "array", - "items": { - "$ref": "#/definitions/CustomHealthcareEntity" - } - }, - "relations": { - "type": "array", - "description": "Healthcare entity relations.", - "items": { - "$ref": "#/definitions/HealthcareRelation" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "entities", - "relations" - ] - }, - "HealthcareEntity": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "x-ms-enum": { - "name": "healthcareEntityCategory", - "modelAsString": true - }, - "type": "string", - "description": "Healthcare Entity Category.", - "enum": [ - "BodyStructure", - "Age", - "Gender", - "Ethnicity", - "ExaminationName", - "Date", - "Direction", - "Frequency", - "MeasurementValue", - "MeasurementUnit", - "RelationalOperator", - "Time", - "Course", - "GeneOrProtein", - "Variant", - "Expression", - "MutationType", - "AdministrativeEvent", - "CareEnvironment", - "HealthcareProfession", - "Diagnosis", - "SymptomOrSign", - "ConditionQualifier", - "ConditionScale", - "MedicationClass", - "MedicationName", - "Dosage", - "MedicationForm", - "MedicationRoute", - "FamilyRelation", - "TreatmentName", - "Allergen", - "Employment", - "LivingStatus", - "SubstanceUse", - "SubstanceUseAmount" - ] - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub type." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted entity." - }, - "assertion": { - "type": "object", - "$ref": "#/definitions/HealthcareAssertion" - }, - "name": { - "description": "Preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'.", - "type": "string" - }, - "links": { - "description": "Entity references in known data sources.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareEntityLink" - } - } - }, - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ] - }, - "CustomHealthcareEntity": { - "type": "object", - "properties": { - "entityComponentInformation": { - "description": "(Optional) Entity component information listing fired components of the extracted entity. This object only applies for custom healthcare.", - "type": "array", - "items": { - "$ref": "#/definitions/EntityComponentInformation" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/HealthcareEntity" - } - ] - }, - "HealthcareRelation": { - "type": "object", - "description": "Every relation is an entity graph of a certain relationType, where all entities are connected and have specific roles within the relation context.", - "required": [ - "relationType", - "entities" - ], - "properties": { - "relationType": { - "description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc.", - "type": "string", - "enum": [ - "Abbreviation", - "BodySiteOfCondition", - "BodySiteOfTreatment", - "CourseOfCondition", - "CourseOfExamination", - "CourseOfMedication", - "CourseOfTreatment", - "DirectionOfBodyStructure", - "DirectionOfCondition", - "DirectionOfExamination", - "DirectionOfTreatment", - "DosageOfMedication", - "ExaminationFindsCondition", - "ExpressionOfGene", - "ExpressionOfVariant", - "FormOfMedication", - "FrequencyOfCondition", - "FrequencyOfMedication", - "FrequencyOfTreatment", - "MutationTypeOfGene", - "MutationTypeOfVariant", - "QualifierOfCondition", - "RelationOfExamination", - "RouteOfMedication", - "ScaleOfCondition", - "TimeOfCondition", - "TimeOfEvent", - "TimeOfExamination", - "TimeOfMedication", - "TimeOfTreatment", - "UnitOfCondition", - "UnitOfExamination", - "ValueOfCondition", - "ValueOfExamination", - "VariantOfGene" - ], - "x-ms-enum": { - "name": "relationType", - "modelAsString": true - } - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted relation." - }, - "entities": { - "description": "The entities in the relation.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthcareRelationEntity" - } - } - } - }, - "HealthcareAssertion": { - "type": "object", - "properties": { - "conditionality": { - "description": "Describes any conditionality on the entity.", - "type": "string", - "enum": [ - "hypothetical", - "conditional" - ], - "x-ms-enum": { - "name": "Conditionality", - "modelAsString": false - } - }, - "certainty": { - "description": "Describes the entities certainty and polarity.", - "type": "string", - "enum": [ - "positive", - "positivePossible", - "neutralPossible", - "negativePossible", - "negative" - ], - "x-ms-enum": { - "name": "Certainty", - "modelAsString": false - } - }, - "association": { - "description": "Describes if the entity is the subject of the text or if it describes someone else.", - "type": "string", - "enum": [ - "subject", - "other" - ], - "x-ms-enum": { - "name": "Association", - "modelAsString": false - } - }, - "temporality": { - "description": "Describes temporal information regarding the entity.", - "type": "string", - "enum": [ - "current", - "past", - "future" - ], - "x-ms-enum": { - "name": "Temporality", - "modelAsString": false - } - } - } - }, - "HealthcareRelationEntity": { - "type": "object", - "required": [ - "ref", - "role" - ], - "properties": { - "ref": { - "description": "Reference link object, using a JSON pointer RFC 6901 (URI Fragment Identifier Representation), pointing to the entity .", - "type": "string" - }, - "role": { - "description": "Role of entity in the relationship. For example: 'CD20-positive diffuse large B-cell lymphoma' has the following entities with their roles in parenthesis: CD20 (GeneOrProtein), Positive (Expression), diffuse large B-cell lymphoma (Diagnosis).", - "type": "string" - } - } - }, - "HealthcareEntityLink": { - "type": "object", - "required": [ - "dataSource", - "id" - ], - "properties": { - "dataSource": { - "description": "Entity Catalog. Examples include: UMLS, CHV, MSH, etc.", - "type": "string" - }, - "id": { - "description": "Entity id in the given source catalog.", - "type": "string" - } - } - }, - "EntityComponentInformation": { - "description": "This object contains information of the detected entity components. The possible component types may expand in the future. Parsing code should handle unexpected values gracefully", - "type": "object", - "discriminator": "entityComponentKind", - "properties": { - "entityComponentKind": { - "description": "The component object kind.", - "type": "string", - "enum": [ - "PrebuiltComponent", - "LearnedComponent", - "ListComponent" - ], - "x-ms-enum": { - "name": "entityComponentKind", - "modelAsString": true - } - } - }, - "required": [ - "entityComponentKind" - ] - }, - "PrebuiltComponent": { - "description": "This object contains information of the prebuilt component of the detected entity.", - "allOf": [ - { - "$ref": "#/definitions/EntityComponentInformation" - } - ], - "type": "object", - "x-ms-discriminator-value": "PrebuiltComponent", - "properties": { - "value": { - "type": "string", - "description": "The prebuilt component of an extracted entity type." - } - } - }, - "LearnedComponent": { - "description": "This object contains information of the learned component of the detected entity.", - "allOf": [ - { - "$ref": "#/definitions/EntityComponentInformation" - } - ], - "type": "object", - "x-ms-discriminator-value": "LearnedComponent", - "properties": { - "value": { - "type": "string", - "description": "The learned component of an extracted entity type." - } - } - }, - "ListComponent": { - "description": "This object contains information of the list component of the detected entity.", - "allOf": [ - { - "$ref": "#/definitions/EntityComponentInformation" - } - ], - "type": "object", - "x-ms-discriminator-value": "ListComponent", - "properties": { - "value": { - "type": "string", - "description": "The list key of an extracted entity type." - } - } - }, - "SentimentAnalysisTaskParameters": { - "type": "object", - "description": "Supported parameters for a Sentiment Analysis task.", - "properties": { - "opinionMining": { - "type": "boolean", - "default": false - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "SentimentAnalysisLROTask": { - "type": "object", - "description": "An object representing the task definition for a Sentiment Analysis task.", - "properties": { - "parameters": { - "$ref": "#/definitions/SentimentAnalysisTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "SentimentAnalysis" - }, - "SentimentTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/SentimentResponse" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "SentimentAnalysisResults" - }, - "SentimentResponse": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Sentiment analysis per document.", - "items": { - "allOf": [ - { - "$ref": "#/definitions/SentimentDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "CustomSentimentDocumentResult": { - "type": "object", - "properties": { - "sentiment": { - "type": "string", - "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).", - "enum": [ - "positive", - "neutral", - "negative", - "mixed" - ], - "x-ms-enum": { - "name": "DocumentSentimentValue", - "modelAsString": false - } - }, - "confidenceScores": { - "description": "Document level sentiment confidence scores between 0 and 1 for each sentiment class.", - "$ref": "#/definitions/SentimentConfidenceScorePerLabel" - }, - "sentences": { - "type": "array", - "description": "Sentence level sentiment analysis.", - "items": { - "$ref": "#/definitions/CustomSentenceSentiment" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "sentiment", - "confidenceScores", - "sentences" - ] - }, - "CustomSentenceSentiment": { - "type": "object", - "required": [ - "text", - "sentiment", - "confidenceScores", - "offset", - "length" - ], - "properties": { - "text": { - "type": "string", - "description": "The sentence text." - }, - "sentiment": { - "type": "string", - "description": "The predicted Sentiment for the sentence.", - "enum": [ - "positive", - "neutral", - "negative" - ], - "x-ms-enum": { - "name": "SentenceSentimentValue", - "modelAsString": false - } - }, - "confidenceScores": { - "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes.", - "$ref": "#/definitions/SentimentConfidenceScorePerLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The sentence offset from the start of the document." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the sentence." - } - } - }, - "SentimentDocumentResult": { - "type": "object", - "properties": { - "sentiment": { - "type": "string", - "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).", - "enum": [ - "positive", - "neutral", - "negative", - "mixed" - ], - "x-ms-enum": { - "name": "DocumentSentimentValue", - "modelAsString": false - } - }, - "confidenceScores": { - "description": "Document level sentiment confidence scores between 0 and 1 for each sentiment class.", - "$ref": "#/definitions/SentimentConfidenceScorePerLabel" - }, - "sentences": { - "type": "array", - "description": "Sentence level sentiment analysis.", - "items": { - "$ref": "#/definitions/SentenceSentiment" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "sentiment", - "confidenceScores", - "sentences" - ] - }, - "SentimentConfidenceScorePerLabel": { - "type": "object", - "required": [ - "positive", - "neutral", - "negative" - ], - "properties": { - "positive": { - "type": "number", - "format": "double", - "description": "Confidence score for positive sentiment" - }, - "neutral": { - "type": "number", - "format": "double", - "description": "Confidence score for neutral sentiment" - }, - "negative": { - "type": "number", - "format": "double", - "description": "Confidence score for negative sentiment" - } - }, - "description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative." - }, - "SentenceSentiment": { - "type": "object", - "required": [ - "text", - "sentiment", - "confidenceScores", - "offset", - "length" - ], - "properties": { - "text": { - "type": "string", - "description": "The sentence text." - }, - "sentiment": { - "type": "string", - "description": "The predicted Sentiment for the sentence.", - "enum": [ - "positive", - "neutral", - "negative" - ], - "x-ms-enum": { - "name": "SentenceSentimentValue", - "modelAsString": false - } - }, - "confidenceScores": { - "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes.", - "$ref": "#/definitions/SentimentConfidenceScorePerLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The sentence offset from the start of the document." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the sentence." - }, - "targets": { - "type": "array", - "description": "The array of sentence targets for the sentence.", - "items": { - "$ref": "#/definitions/SentenceTarget" - } - }, - "assessments": { - "type": "array", - "description": "The array of assessments for the sentence.", - "items": { - "$ref": "#/definitions/SentenceAssessment" - } - } - } - }, - "SentenceTarget": { - "type": "object", - "required": [ - "confidenceScores", - "length", - "offset", - "relations", - "sentiment", - "text" - ], - "properties": { - "sentiment": { - "type": "string", - "enum": [ - "positive", - "mixed", - "negative" - ], - "x-ms-enum": { - "name": "TokenSentimentValue", - "modelAsString": false - }, - "description": "Targeted sentiment in the sentence." - }, - "confidenceScores": { - "description": "Target sentiment confidence scores for the target in the sentence.", - "$ref": "#/definitions/TargetConfidenceScoreLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The target offset from the start of the sentence." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the target." - }, - "text": { - "type": "string", - "description": "The target text detected." - }, - "relations": { - "type": "array", - "description": "The array of either assessment or target objects which is related to the target.", - "items": { - "$ref": "#/definitions/TargetRelation" - } - } - } - }, - "SentenceAssessment": { - "type": "object", - "required": [ - "confidenceScores", - "isNegated", - "length", - "offset", - "sentiment", - "text" - ], - "properties": { - "sentiment": { - "type": "string", - "enum": [ - "positive", - "mixed", - "negative" - ], - "x-ms-enum": { - "name": "TokenSentimentValue", - "modelAsString": false - }, - "description": "Assessment sentiment in the sentence." - }, - "confidenceScores": { - "description": "Assessment sentiment confidence scores in the sentence.", - "$ref": "#/definitions/TargetConfidenceScoreLabel" - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The assessment offset from the start of the sentence." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the assessment." - }, - "text": { - "type": "string", - "description": "The assessment text detected." - }, - "isNegated": { - "type": "boolean", - "description": "The indicator representing if the assessment is negated." - } - } - }, - "TargetRelation": { - "type": "object", - "required": [ - "ref", - "relationType" - ], - "properties": { - "relationType": { - "type": "string", - "enum": [ - "assessment", - "target" - ], - "x-ms-enum": { - "name": "TargetRelationType", - "modelAsString": false - }, - "description": "The type related to the target." - }, - "ref": { - "type": "string", - "description": "The JSON pointer indicating the linked object." - } - } - }, - "TargetConfidenceScoreLabel": { - "type": "object", - "required": [ - "negative", - "positive" - ], - "properties": { - "positive": { - "type": "number", - "format": "double", - "description": "Confidence score for positive sentiment" - }, - "negative": { - "type": "number", - "format": "double", - "description": "Confidence score for negative sentiment" - } - }, - "description": "Represents the confidence scores across all sentiment classes: positive and negative." - }, - "CustomSentimentAnalysisTaskParameters": { - "type": "object", - "description": "Supported parameters for a Custom Sentiment Analysis task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/CustomTaskParameters" - } - ] - }, - "CustomSentimentAnalysisLROTask": { - "type": "object", - "description": "Use custom models to ease the process of sentiment analysis from documents like product reviews", - "properties": { - "parameters": { - "$ref": "#/definitions/CustomSentimentAnalysisTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomSentimentAnalysis" - }, - "CustomSentimentAnalysisResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Sentiment analysis per document.", - "items": { - "allOf": [ - { - "$ref": "#/definitions/CustomSentimentDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/CustomResult" - } - ], - "required": [ - "documents" - ] - }, - "EntityList": { - "description": "(Optional) describes the entity categories.", - "items": { - "type": "string", - "enum": [ - "Address", - "Numeric", - "Age", - "Currency", - "Number", - "NumberRange", - "Percentage", - "Ordinal", - "Temperature", - "Dimension", - "Length", - "Weight", - "Height", - "Speed", - "Area", - "Volume", - "Information", - "Temporal", - "Date", - "Time", - "DateTime", - "DateRange", - "TimeRange", - "DateTimeRange", - "Duration", - "SetTemporal", - "Event", - "SportsEvent", - "CulturalEvent", - "NaturalEvent", - "Location", - "GPE", - "City", - "State", - "CountryRegion", - "Continent", - "Structural", - "Airport", - "Geological", - "Organization", - "OrganizationMedical", - "OrganizationStockExchange", - "OrganizationSports", - "Person", - "PersonType", - "Email", - "URL", - "IP", - "PhoneNumber", - "Product", - "ComputingProduct", - "Skill" - ], - "x-ms-enum": { - "name": "EntityCategory", - "modelAsString": true, - "values": [ - { - "value": "Address", - "description": "Specific street-level mentions of locations: house/building numbers, streets, avenues, highways, intersections referenced by name." - }, - { - "value": "Numeric", - "description": "Numeric values, including digits and number words." - }, - { - "value": "Age", - "description": "Age-related values." - }, - { - "value": "Currency", - "description": "Currency-related values." - }, - { - "value": "Number", - "description": "Numbers without a unit" - }, - { - "value": "NumberRange", - "description": "Range of Numbers" - }, - { - "value": "Percentage", - "description": "Percentage-related values." - }, - { - "value": "Ordinal", - "description": "Ordinal numbers." - }, - { - "value": "Temperature", - "description": "Temperature-related values." - }, - { - "value": "Dimension", - "description": "Dimension of measurements" - }, - { - "value": "Length", - "description": "Length of an object." - }, - { - "value": "Weight", - "description": "Weight of an object." - }, - { - "value": "Height", - "description": "Height of an object." - }, - { - "value": "Speed", - "description": "Speed of an object." - }, - { - "value": "Area", - "description": "Area of an object." - }, - { - "value": "Volume", - "description": "Volume of an object." - }, - { - "value": "Information", - "description": "Unit of measure for digital information." - }, - { - "value": "Temporal", - "description": "Items relating to time." - }, - { - "value": "Date", - "description": "Calendar dates." - }, - { - "value": "Time", - "description": "Times of day." - }, - { - "value": "DateTime", - "description": "Calendar dates with time." - }, - { - "value": "DateRange", - "description": "Range of dates." - }, - { - "value": "TimeRange", - "description": "Range of times." - }, - { - "value": "DateTimeRange", - "description": "Range of date and time." - }, - { - "value": "Duration", - "description": "Duration of time." - }, - { - "value": "SetTemporal", - "description": "Set of time-related values." - }, - { - "value": "Event", - "description": "Social, sports, business, political, educational, natural, historical, criminal, violent, legal, military events with a timed period." - }, - { - "value": "SportsEvent", - "description": "Sports event-related values." - }, - { - "value": "CulturalEvent", - "description": "Cultural event-related values." - }, - { - "value": "NaturalEvent", - "description": "Natural event-related values." - }, - { - "value": "Location", - "description": "Particular point or place in physical space." - }, - { - "value": "GPE", - "description": "Cities, countries/regions, states.", - "name": "GeoPoliticalEntity" - }, - { - "value": "City", - "description": "City-related values." - }, - { - "value": "State", - "description": "State-related values." - }, - { - "value": "CountryRegion", - "description": "Country or region-related values." - }, - { - "value": "Continent", - "description": "Continent-related values." - }, - { - "value": "Structural", - "description": "Manmade structures." - }, - { - "value": "Airport", - "description": "Airports." - }, - { - "value": "Geological", - "description": " Geographic and natural features such as rivers, oceans, and deserts." - }, - { - "value": "Organization", - "description": "Corporations, agencies, and other groups of people defined by some established organizational structure. These labels can include companies, political parties/movements, musical bands, sport clubs, government bodies, and public organizations. Nationalities or religions are not ORGANIZATION." - }, - { - "value": "OrganizationMedical", - "description": "Medical companies and groups." - }, - { - "value": "OrganizationStockExchange", - "description": "Stock exchange groups." - }, - { - "value": "OrganizationSports", - "description": "Sports-related organizations." - }, - { - "value": "Person", - "description": "First, last, and middle names, names of fictional characters, and aliases. Titles, such as “Mr.” or “President”, are not considered part of the named entity." - }, - { - "value": "PersonType", - "description": "Human roles classified by a group membership." - }, - { - "value": "Email", - "description": "Email addresses." - }, - { - "value": "URL", - "description": "URLs to websites." - }, - { - "value": "IP", - "description": "network IP addresses." - }, - { - "value": "PhoneNumber", - "description": "Phone numbers (US and EU phone numbers only)." - }, - { - "value": "Product", - "description": "Single or group of commercial, consumable objects, electronics, vehicles, food groups." - }, - { - "value": "ComputingProduct", - "description": "Computing products." - }, - { - "value": "Skill", - "description": "A capability, skill, or expertise." - } - ] - } - }, - "type": "array", - "uniqueItems": true - }, - "BaseEntityOverlapPolicy": { - "description": "The abstract base class for entity OverlapPolicy.", - "type": "object", - "discriminator": "policyKind", - "properties": { - "policyKind": { - "description": "The entity OverlapPolicy object kind.", - "type": "string", - "default": "matchLongest", - "enum": [ - "matchLongest", - "allowOverlap" - ], - "x-ms-enum": { - "name": "policyKind", - "modelAsString": true - } - } - }, - "required": [ - "policyKind" - ] - }, - "MatchLongestEntityPolicyType": { - "description": "Represents the Match longest overlap policy. No overlapping entities as far as it is possible. 1. If there are overlapping entities, the longest one will be returned. 2. If the set of characters predicted for 2 or more entities are exactly the same, select the entity that has the higher confidence score.3. If the entity scores are identical, return all entities that are still present after applying the previous rules. 3. If there is partial overlap (as in Hello Text Analytics) follow the above steps starting from 1. ", - "allOf": [ - { - "$ref": "#/definitions/BaseEntityOverlapPolicy" - } - ], - "type": "object", - "x-ms-discriminator-value": "matchLongest" - }, - "AllowOverlapEntityPolicyType": { - "description": "Represents the allow overlap policy. Will apply no post processing logic for the entities. Whatever the model predicts is what will be returned to the user. This allows the user to get a full view of every single model's possible values and apply their own custom logic on entity selection", - "allOf": [ - { - "$ref": "#/definitions/BaseEntityOverlapPolicy" - } - ], - "type": "object", - "x-ms-discriminator-value": "allowOverlap" - }, - "EntitiesTaskParameters": { - "type": "object", - "description": "Supported parameters for an Entity Recognition task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - }, - "inclusionList": { - "description": "(Optional) request parameter that limits the output to the requested entity types included in this list. We will apply inclusionList before exclusionList", - "$ref": "#/definitions/EntityList" - }, - "exclusionList": { - "description": "(Optional) request parameter that filters out any entities that are included the excludeList. When a user specifies an excludeList, they cannot get a prediction returned with an entity in that list. We will apply inclusionList before exclusionList", - "$ref": "#/definitions/EntityList" - }, - "overlapPolicy": { - "description": "(Optional) describes the type of overlap policy to apply to the ner output.", - "$ref": "#/definitions/BaseEntityOverlapPolicy" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "EntitiesLROTask": { - "type": "object", - "description": "An object representing the task definition for an Entities Recognition task.", - "properties": { - "parameters": { - "$ref": "#/definitions/EntitiesTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "EntityRecognition" - }, - "EntitiesTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityRecognitionResults" - }, - "EntitiesResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "$ref": "#/definitions/EntitiesResultWithDetectedLanguage" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "EntitiesResultWithDetectedLanguage": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/EntitiesDocumentResultWithMetadata" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - }, - "EntitiesDocumentResult": { - "type": "object", - "properties": { - "entities": { - "type": "array", - "description": "Recognized entities in the document.", - "items": { - "$ref": "#/definitions/Entity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "entities" - ] - }, - "EntitiesDocumentResultWithMetadata": { - "type": "object", - "properties": { - "entities": { - "type": "array", - "description": "Recognized entities in the document.", - "items": { - "$ref": "#/definitions/EntityWithMetadata" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "entities" - ] - }, - "EntityTag": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Tags are to express some similarities/affinity between entities. Entity Tags will be unique globally." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Detection score between 0 and 1 of the extracted entity." - } - }, - "required": [ - "name" - ] - }, - "Entity": { - "type": "object", - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ], - "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "type": "string", - "description": "Entity type." - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub type." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted entity." - } - } - }, - "EntityWithTags": { - "allOf": [ - { - "$ref": "#/definitions/Entity" - } - ], - "type": "object", - "required": [ - "type", - "tags" - ], - "properties": { - "type": { - "type": "string", - "description": "An entity type is the lowest (or finest) granularity at which the entity has been detected. The type maps to the specific metadata attributes associated with the entity detected." - }, - "tags": { - "type": "array", - "description": "List of entity tags. Tags are to express some similarities/affinity between entities.", - "items": { - "$ref": "#/definitions/EntityTag" - } - } - } - }, - "EntityWithMetadata": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/EntityWithTags" - } - ], - "properties": { - "metadata": { - "description": "The entity metadata object.", - "type": "object", - "$ref": "#/definitions/BaseMetadata" - } - } - }, - "EntityLinkingTaskParameters": { - "type": "object", - "description": "Supported parameters for an Entity Linking task.", - "properties": { - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "EntityLinkingLROTask": { - "type": "object", - "description": "An object representing the task definition for an Entity Linking task.", - "properties": { - "parameters": { - "$ref": "#/definitions/EntityLinkingTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "EntityLinking" - }, - "EntityLinkingTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntityLinkingResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityLinkingResults" - }, - "EntityLinkingResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "$ref": "#/definitions/EntityLinkingResultWithDetectedLanguage" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "EntityLinkingResultWithDetectedLanguage": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/LinkedEntitiesDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - }, - "LinkedEntitiesDocumentResult": { - "type": "object", - "required": [ - "entities" - ], - "properties": { - "entities": { - "type": "array", - "description": "Recognized well known entities in the document.", - "items": { - "$ref": "#/definitions/LinkedEntity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ] - }, - "LinkedEntity": { - "type": "object", - "required": [ - "name", - "matches", - "language", - "url", - "dataSource" - ], - "properties": { - "name": { - "type": "string", - "description": "Entity Linking formal name." - }, - "matches": { - "type": "array", - "description": "List of instances this entity appears in the text.", - "items": { - "$ref": "#/definitions/Match" - } - }, - "language": { - "type": "string", - "description": "Language used in the data source." - }, - "id": { - "type": "string", - "description": "Unique identifier of the recognized entity from the data source." - }, - "url": { - "type": "string", - "description": "URL for the entity's page from the data source." - }, - "dataSource": { - "type": "string", - "description": "Data source used to extract entity linking, such as Wiki/Bing etc." - }, - "bingId": { - "type": "string", - "description": "Bing Entity Search API unique identifier of the recognized entity." - } - } - }, - "AgeUnit": { - "type": "string", - "enum": [ - "Unspecified", - "Year", - "Month", - "Week", - "Day" - ], - "x-ms-enum": { - "name": "AgeUnit", - "modelAsString": true - }, - "description": "The Age Unit of measurement" - }, - "VolumeUnit": { - "type": "string", - "enum": [ - "Unspecified", - "CubicMeter", - "CubicCentimeter", - "CubicMillimeter", - "Hectoliter", - "Decaliter", - "Liter", - "Centiliter", - "Milliliter", - "CubicYard", - "CubicInch", - "CubicFoot", - "CubicMile", - "FluidOunce", - "Teaspoon", - "Tablespoon", - "Pint", - "Quart", - "Cup", - "Gill", - "Pinch", - "FluidDram", - "Barrel", - "Minim", - "Cord", - "Peck", - "Bushel", - "Hogshead" - ], - "x-ms-enum": { - "name": "VolumeUnit", - "modelAsString": true - }, - "description": "The Volume Unit of measurement" - }, - "SpeedUnit": { - "type": "string", - "enum": [ - "Unspecified", - "MetersPerSecond", - "KilometersPerHour", - "KilometersPerMinute", - "KilometersPerSecond", - "MilesPerHour", - "Knots", - "FeetPerSecond", - "FeetPerMinute", - "YardsPerMinute", - "YardsPerSecond", - "MetersPerMillisecond", - "CentimetersPerMillisecond", - "KilometersPerMillisecond" - ], - "x-ms-enum": { - "name": "SpeedUnit", - "modelAsString": true - }, - "description": "The speed Unit of measurement" - }, - "AreaUnit": { - "type": "string", - "enum": [ - "Unspecified", - "SquareKilometer", - "SquareHectometer", - "SquareDecameter", - "SquareDecimeter", - "SquareMeter", - "SquareCentimeter", - "SquareMillimeter", - "SquareInch", - "SquareFoot", - "SquareMile", - "SquareYard", - "Acre" - ], - "x-ms-enum": { - "name": "AreaUnit", - "modelAsString": true - }, - "description": "The area Unit of measurement" - }, - "LengthUnit": { - "type": "string", - "enum": [ - "Unspecified", - "Kilometer", - "Hectometer", - "Decameter", - "Meter", - "Decimeter", - "Centimeter", - "Millimeter", - "Micrometer", - "Nanometer", - "Picometer", - "Mile", - "Yard", - "Inch", - "Foot", - "LightYear", - "Point" - ], - "x-ms-enum": { - "name": "LengthUnit", - "modelAsString": true - }, - "description": "The length Unit of measurement" - }, - "InformationUnit": { - "type": "string", - "enum": [ - "Unspecified", - "Bit", - "Kilobit", - "Megabit", - "Gigabit", - "Terabit", - "Petabit", - "Byte", - "Kilobyte", - "Megabyte", - "Gigabyte", - "Terabyte", - "Petabyte" - ], - "x-ms-enum": { - "name": "InformationUnit", - "modelAsString": true, - "values": [ - { - "value": "Unspecified", - "description": "Unspecified information unit." - }, - { - "value": "Bit", - "description": "Bit information unit. " - }, - { - "value": "Kilobit", - "description": "Kilobit information unit. Usually defined as 1000 bits or 1024 bits." - }, - { - "value": "Megabit", - "description": "Megabit information unit. Usually defined as 1000 kilobits or 1024 kilobits." - }, - { - "value": "Gigabit", - "description": "Gigabit information unit. Usually defined as 1000 megabits or 1024 megabits." - }, - { - "value": "Terabit", - "description": "Terabit information unit. Usually defined as 1000 gigabits or 1024 gigabits." - }, - { - "value": "Petabit", - "description": "Petabit information unit. Usually defined as 1000 terabits or 1024 terabits." - }, - { - "value": "Byte", - "description": "Byte information unit. Usually defined as 8 bits are used to form a byte.." - }, - { - "value": "Kilobyte", - "description": "Kilobyte information unit. Usually defined as 1000 bytes or 1024 bytes." - }, - { - "value": "Megabyte", - "description": "Megabyte information unit. Usually defined as 1000 kilobytes or 1024 kilobytes." - }, - { - "value": "Gigabyte", - "description": "Gigabyte information unit. Usually defined as 1000 megabytes or 1024 megabytes." - }, - { - "value": "Terabyte", - "description": "Terabyte information unit. Usually defined as 1000 gigabytes or 1024 gigabytes." - }, - { - "value": "Petabyte", - "description": "Petabyte information unit. Usually defined as 1000 terabytes or 1024 terabytes." - } - ] - }, - "description": "The information (data) Unit of measurement." - }, - "TemperatureUnit": { - "type": "string", - "enum": [ - "Unspecified", - "Fahrenheit", - "Kelvin", - "Rankine", - "Celsius" - ], - "x-ms-enum": { - "name": "TemperatureUnit", - "modelAsString": true - }, - "description": "The temperature Unit of measurement." - }, - "WeightUnit": { - "type": "string", - "enum": [ - "Unspecified", - "Kilogram", - "Gram", - "Milligram", - "Gallon", - "MetricTon", - "Ton", - "Pound", - "Ounce", - "Grain", - "PennyWeight", - "LongTonBritish", - "ShortTonUS", - "ShortHundredWeightUS", - "Stone", - "Dram" - ], - "x-ms-enum": { - "name": "WeightUnit", - "modelAsString": true - }, - "description": "The weight Unit of measurement." - }, - "NumberKind": { - "type": "string", - "enum": [ - "Integer", - "Decimal", - "Power", - "Fraction", - "Percent", - "Unspecified" - ], - "x-ms-enum": { - "name": "NumberKind", - "modelAsString": true - }, - "description": "The type of the extracted number entity." - }, - "OrdinalRelativeTo": { - "type": "string", - "enum": [ - "Current", - "End", - "Start" - ], - "x-ms-enum": { - "name": "RelativeTo", - "modelAsString": true - }, - "description": "The reference point that the ordinal number denotes." - }, - "RangeInclusivity": { - "type": "string", - "enum": [ - "NoneInclusive", - "LeftInclusive", - "RightInclusive", - "LeftRightInclusive" - ], - "x-ms-enum": { - "name": "RangeInclusivity", - "modelAsString": true - }, - "description": "The range inclusiveness of this property property." - }, - "NumericRangeKind": { - "type": "string", - "enum": [ - "Number", - "Speed", - "Weight", - "Length", - "Volume", - "Area", - "Age", - "Information", - "Temperature", - "Currency" - ], - "x-ms-enum": { - "name": "RangeKind", - "modelAsString": true - }, - "description": "The kind of range that the resolution object represents." - }, - "BaseMetadata": { - "description": "The abstract base class for entity Metadata.", - "type": "object", - "discriminator": "metadataKind", - "properties": { - "metadataKind": { - "description": "The entity Metadata object kind.", - "type": "string", - "enum": [ - "DateMetadata", - "DateTimeMetadata", - "TimeMetadata", - "TemporalSetMetadata", - "NumberMetadata", - "OrdinalMetadata", - "SpeedMetadata", - "WeightMetadata", - "LengthMetadata", - "VolumeMetadata", - "AreaMetadata", - "AgeMetadata", - "InformationMetadata", - "TemperatureMetadata", - "CurrencyMetadata", - "NumericRangeMetadata", - "TemporalSpanMetadata" - ], - "x-ms-enum": { - "name": "MetadataKind", - "modelAsString": true - } - } - }, - "required": [ - "metadataKind" - ] - }, - "QuantityMetadata": { - "description": "Represents Metadata for quantities.", - "type": "object", - "properties": { - "value": { - "type": "number", - "format": "double", - "description": "The numeric value that the extracted text denotes." - } - }, - "required": [ - "value" - ] - }, - "AgeMetadata": { - "description": "Represents the Age entity Metadata model.", - "allOf": [ - { - "$ref": "#/definitions/BaseMetadata" - }, - { - "$ref": "#/definitions/QuantityMetadata" - } - ], - "type": "object", - "x-ms-discriminator-value": "AgeMetadata", - "properties": { - "unit": { - "$ref": "#/definitions/AgeUnit" - } - }, - "required": [ - "unit" - ] - }, - "VolumeMetadata": { - "description": "Represents the volume entity Metadata model.", - "allOf": [ - { - "$ref": "#/definitions/BaseMetadata" - }, - { - "$ref": "#/definitions/QuantityMetadata" - } - ], - "type": "object", - "x-ms-discriminator-value": "VolumeMetadata", - "properties": { - "unit": { - "$ref": "#/definitions/VolumeUnit" - } - }, - "required": [ - "unit" - ] - }, - "SpeedMetadata": { - "description": "Represents the speed entity Metadata model.", - "allOf": [ - { - "$ref": "#/definitions/BaseMetadata" - }, - { - "$ref": "#/definitions/QuantityMetadata" - } - ], - "type": "object", - "x-ms-discriminator-value": "SpeedMetadata", - "properties": { - "unit": { - "$ref": "#/definitions/SpeedUnit" - } - }, - "required": [ - "unit" - ] - }, - "AreaMetadata": { - "description": "Represents the area entity Metadata model.", - "allOf": [ - { - "$ref": "#/definitions/BaseMetadata" - }, - { - "$ref": "#/definitions/QuantityMetadata" - } - ], - "type": "object", - "x-ms-discriminator-value": "AreaMetadata", - "properties": { - "unit": { - "$ref": "#/definitions/AreaUnit" - } - }, - "required": [ - "unit" - ] - }, - "LengthMetadata": { - "description": "Represents the length entity Metadata model.", - "allOf": [ - { - "$ref": "#/definitions/BaseMetadata" - }, - { - "$ref": "#/definitions/QuantityMetadata" - } - ], - "type": "object", - "x-ms-discriminator-value": "LengthMetadata", - "properties": { - "unit": { - "$ref": "#/definitions/LengthUnit" - } - }, - "required": [ - "unit" - ] - }, - "InformationMetadata": { - "description": "Represents the information (data) entity Metadata model.", - "allOf": [ - { - "$ref": "#/definitions/BaseMetadata" - }, - { - "$ref": "#/definitions/QuantityMetadata" - } - ], - "type": "object", - "x-ms-discriminator-value": "InformationMetadata", - "properties": { - "unit": { - "$ref": "#/definitions/InformationUnit" - } - }, - "required": [ - "unit" - ] - }, - "TemperatureMetadata": { - "description": "Represents the temperature entity Metadata model.", - "allOf": [ - { - "$ref": "#/definitions/BaseMetadata" - }, - { - "$ref": "#/definitions/QuantityMetadata" - } - ], - "type": "object", - "x-ms-discriminator-value": "TemperatureMetadata", - "properties": { - "unit": { - "$ref": "#/definitions/TemperatureUnit" - } - }, - "required": [ - "unit" - ] - }, - "WeightMetadata": { - "description": "Represents the weight entity Metadata model.", - "allOf": [ - { - "$ref": "#/definitions/BaseMetadata" - }, - { - "$ref": "#/definitions/QuantityMetadata" - } - ], - "type": "object", - "x-ms-discriminator-value": "WeightMetadata", - "properties": { - "unit": { - "$ref": "#/definitions/WeightUnit" - } - }, - "required": [ - "unit" - ] - }, - "CurrencyMetadata": { - "description": "Represents the currency entity Metadata model.", - "allOf": [ - { - "$ref": "#/definitions/BaseMetadata" - }, - { - "$ref": "#/definitions/QuantityMetadata" - } - ], - "type": "object", - "x-ms-discriminator-value": "CurrencyMetadata", - "properties": { - "iso4217": { - "type": "string", - "description": "The alphabetic code based on another ISO standard, ISO 3166, which lists the codes for country names. The first two letters of the ISO 4217 three-letter code are the same as the code for the country name, and, where possible, the third letter corresponds to the first letter of the currency name." - }, - "value": { - "type": "number", - "format": "double", - "description": "The money amount captured in the extracted entity" - }, - "unit": { - "type": "string", - "description": "The unit of the amount captured in the extracted entity" - } - }, - "required": [ - "value", - "unit" - ] - }, - "DateValue": { - "description": "Represents the date value.", - "type": "object", - "properties": { - "timex": { - "$ref": "#/definitions/TimeExpression" - }, - "value": { - "type": "string", - "description": "The actual time that the extracted text denote." - }, - "modifier": { - "$ref": "#/definitions/TemporalModifier" - } - }, - "required": [ - "timex", - "value" - ] - }, - "BaseTemporalMetadata": { - "type": "object", - "properties": { - "dateValues": { - "type": "array", - "description": "The list of date values.", - "items": { - "$ref": "#/definitions/DateValue" - } - } - } - }, - "DateMetadata": { - "description": "A Metadata for date entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseMetadata" - }, - { - "$ref": "#/definitions/BaseTemporalMetadata" - } - ], - "type": "object", - "x-ms-discriminator-value": "DateMetadata" - }, - "DateTimeMetadata": { - "description": "A Metadata for datetime entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseMetadata" - }, - { - "$ref": "#/definitions/BaseTemporalMetadata" - } - ], - "type": "object", - "x-ms-discriminator-value": "DateTimeMetadata" - }, - "TemporalSetMetadata": { - "description": "A Metadata for temporal set entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseMetadata" - }, - { - "$ref": "#/definitions/BaseTemporalMetadata" - } - ], - "type": "object", - "x-ms-discriminator-value": "TemporalSetMetadata" - }, - "TimeMetadata": { - "description": "A Metadata for time entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseMetadata" - }, - { - "$ref": "#/definitions/BaseTemporalMetadata" - } - ], - "type": "object", - "x-ms-discriminator-value": "TimeMetadata" - }, - "NumberMetadata": { - "description": "A metadata for numeric entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseMetadata" - } - ], - "type": "object", - "x-ms-discriminator-value": "NumberMetadata", - "properties": { - "numberKind": { - "$ref": "#/definitions/NumberKind" - }, - "value": { - "type": "number", - "format": "double", - "description": "A numeric representation of what the extracted text denotes." - } - }, - "required": [ - "numberKind", - "value" - ] - }, - "OrdinalMetadata": { - "description": "A Metadata for ordinal numbers entity instances.", - "allOf": [ - { - "$ref": "#/definitions/BaseMetadata" - } - ], - "type": "object", - "x-ms-discriminator-value": "OrdinalMetadata", - "properties": { - "offset": { - "type": "string", - "description": "The offset With respect to the reference (e.g., offset = -1 in \"show me the second to last\"" - }, - "relativeTo": { - "$ref": "#/definitions/OrdinalRelativeTo" - }, - "value": { - "type": "string", - "description": "A simple arithmetic expression that the ordinal denotes." - } - }, - "required": [ - "offset", - "relativeTo", - "value" - ] - }, - "TemporalSpanMetadata": { - "description": "represents the Metadata of a date and/or time span.", - "allOf": [ - { - "$ref": "#/definitions/BaseMetadata" - } - ], - "type": "object", - "x-ms-discriminator-value": "TemporalSpanMetadata", - "properties": { - "spanValues": { - "$ref": "#/definitions/TemporalSpanValues" - } - } - }, - "TemporalSpanValues": { - "type": "object", - "properties": { - "begin": { - "$ref": "#/definitions/TimeExpression" - }, - "end": { - "$ref": "#/definitions/TimeExpression" - }, - "duration": { - "type": "string", - "description": "An optional duration value formatted based on the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)" - }, - "modifier": { - "$ref": "#/definitions/TemporalModifier" - }, - "timex": { - "type": "string", - "description": "An optional triplet containing the beginning, the end, and the duration all stated as ISO 8601 formatted strings." - } - } - }, - "NumericRangeMetadata": { - "description": "represents the Metadata of numeric intervals.", - "allOf": [ - { - "$ref": "#/definitions/BaseMetadata" - } - ], - "type": "object", - "x-ms-discriminator-value": "NumericRangeMetadata", - "properties": { - "rangeKind": { - "$ref": "#/definitions/NumericRangeKind" - }, - "minimum": { - "type": "number", - "format": "double", - "description": "The beginning value of the interval." - }, - "maximum": { - "type": "number", - "format": "double", - "description": "The ending value of the interval." - }, - "rangeInclusivity": { - "$ref": "#/definitions/RangeInclusivity" - } - }, - "required": [ - "rangeKind", - "minimum", - "maximum" - ] - }, - "TemporalModifier": { - "type": "string", - "description": "An optional modifier of a date/time instance.", - "enum": [ - "AfterApprox", - "Before", - "BeforeStart", - "Approx", - "ReferenceUndefined", - "SinceEnd", - "AfterMid", - "Start", - "After", - "BeforeEnd", - "Until", - "End", - "Less", - "Since", - "AfterStart", - "BeforeApprox", - "Mid", - "More" - ], - "x-ms-enum": { - "name": "TemporalModifier", - "modelAsString": true - } - }, - "TimeExpression": { - "type": "string", - "description": "An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)" - }, - "Match": { - "type": "object", - "required": [ - "confidenceScore", - "text", - "offset", - "length" - ], - "properties": { - "confidenceScore": { - "type": "number", - "format": "double", - "description": "If a well known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned." - }, - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the entity match text." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length for the entity match text." - } - } - }, - "PiiTaskParameters": { - "type": "object", - "description": "Supported parameters for a PII Entities Recognition task.", - "properties": { - "domain": { - "$ref": "#/definitions/PiiDomain" - }, - "piiCategories": { - "$ref": "#/definitions/PiiCategories" - }, - "excludePiiCategories": { - "$ref": "#/definitions/PiiCategoriesExclude" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - }, - "redactionCharacter": { - "$ref": "common.json#/definitions/RedactionCharacter" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "PiiLROTask": { - "type": "object", - "description": "An object representing the task definition for a PII Entities Recognition task.", - "properties": { - "parameters": { - "$ref": "#/definitions/PiiTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "PiiEntityRecognition" - }, - "PiiTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/PiiResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "PiiEntityRecognitionResults" - }, - "PiiResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "$ref": "#/definitions/PIIResultWithDetectedLanguage" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "PIIResultWithDetectedLanguage": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/PiiEntitiesDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - }, - "PiiDomain": { - "type": "string", - "description": "The PII domain used for PII Entity Recognition.", - "default": "none", - "enum": [ - "phi", - "none" - ], - "x-ms-enum": { - "name": "PiiDomain", - "modelAsString": true, - "values": [ - { - "name": "phi", - "description": "Indicates that entities in the Personal Health Information domain should be redacted.", - "value": "phi" - }, - { - "name": "none", - "description": "Indicates that no domain is specified.", - "value": "none" - } - ] - } - }, - "PiiEntitiesDocumentResult": { - "type": "object", - "properties": { - "redactedText": { - "type": "string", - "description": "Returns redacted text." - }, - "entities": { - "type": "array", - "description": "Recognized entities in the document.", - "items": { - "$ref": "#/definitions/Entity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "redactedText", - "entities" - ] - }, - "PiiCategories": { - "description": "(Optional) describes the PII categories to return", - "items": { - "type": "string", - "x-ms-enum": { - "name": "PiiCategory", - "modelAsString": true - }, - "enum": [ - "ABARoutingNumber", - "ARNationalIdentityNumber", - "AUBankAccountNumber", - "AUDriversLicenseNumber", - "AUMedicalAccountNumber", - "AUPassportNumber", - "AUTaxFileNumber", - "AUBusinessNumber", - "AUCompanyNumber", - "ATIdentityCard", - "ATTaxIdentificationNumber", - "ATValueAddedTaxNumber", - "AzureDocumentDBAuthKey", - "AzureIAASDatabaseConnectionAndSQLString", - "AzureIoTConnectionString", - "AzurePublishSettingPassword", - "AzureRedisCacheString", - "AzureSAS", - "AzureServiceBusString", - "AzureStorageAccountKey", - "AzureStorageAccountGeneric", - "BENationalNumber", - "BENationalNumberV2", - "BEValueAddedTaxNumber", - "BRCPFNumber", - "BRLegalEntityNumber", - "BRNationalIDRG", - "BGUniformCivilNumber", - "CABankAccountNumber", - "CADriversLicenseNumber", - "CAHealthServiceNumber", - "CAPassportNumber", - "CAPersonalHealthIdentification", - "CASocialInsuranceNumber", - "CLIdentityCardNumber", - "CNResidentIdentityCardNumber", - "CreditCardNumber", - "HRIdentityCardNumber", - "HRNationalIDNumber", - "HRPersonalIdentificationNumber", - "HRPersonalIdentificationOIBNumberV2", - "CYIdentityCard", - "CYTaxIdentificationNumber", - "CZPersonalIdentityNumber", - "CZPersonalIdentityV2", - "DKPersonalIdentificationNumber", - "DKPersonalIdentificationV2", - "DrugEnforcementAgencyNumber", - "EEPersonalIdentificationCode", - "EUDebitCardNumber", - "EUDriversLicenseNumber", - "EUGPSCoordinates", - "EUNationalIdentificationNumber", - "EUPassportNumber", - "EUSocialSecurityNumber", - "EUTaxIdentificationNumber", - "FIEuropeanHealthNumber", - "FINationalID", - "FINationalIDV2", - "FIPassportNumber", - "FRDriversLicenseNumber", - "FRHealthInsuranceNumber", - "FRNationalID", - "FRPassportNumber", - "FRSocialSecurityNumber", - "FRTaxIdentificationNumber", - "FRValueAddedTaxNumber", - "DEDriversLicenseNumber", - "DEPassportNumber", - "DEIdentityCardNumber", - "DETaxIdentificationNumber", - "DEValueAddedNumber", - "GRNationalIDCard", - "GRNationalIDV2", - "GRTaxIdentificationNumber", - "HKIdentityCardNumber", - "HUValueAddedNumber", - "HUPersonalIdentificationNumber", - "HUTaxIdentificationNumber", - "INPermanentAccount", - "INUniqueIdentificationNumber", - "IDIdentityCardNumber", - "InternationalBankingAccountNumber", - "IEPersonalPublicServiceNumber", - "IEPersonalPublicServiceNumberV2", - "ILBankAccountNumber", - "ILNationalID", - "ITDriversLicenseNumber", - "ITFiscalCode", - "ITValueAddedTaxNumber", - "JPBankAccountNumber", - "JPDriversLicenseNumber", - "JPPassportNumber", - "JPResidentRegistrationNumber", - "JPSocialInsuranceNumber", - "JPMyNumberCorporate", - "JPMyNumberPersonal", - "JPResidenceCardNumber", - "LVPersonalCode", - "LTPersonalCode", - "LUNationalIdentificationNumberNatural", - "LUNationalIdentificationNumberNonNatural", - "MYIdentityCardNumber", - "MTIdentityCardNumber", - "MTTaxIDNumber", - "NLCitizensServiceNumber", - "NLCitizensServiceNumberV2", - "NLTaxIdentificationNumber", - "NLValueAddedTaxNumber", - "NZBankAccountNumber", - "NZDriversLicenseNumber", - "NZInlandRevenueNumber", - "NZMinistryOfHealthNumber", - "NZSocialWelfareNumber", - "NOIdentityNumber", - "PHUnifiedMultiPurposeIDNumber", - "PLIdentityCard", - "PLNationalID", - "PLNationalIDV2", - "PLPassportNumber", - "PLTaxIdentificationNumber", - "PLREGONNumber", - "PTCitizenCardNumber", - "PTCitizenCardNumberV2", - "PTTaxIdentificationNumber", - "ROPersonalNumericalCode", - "RUPassportNumberDomestic", - "RUPassportNumberInternational", - "SANationalID", - "SGNationalRegistrationIdentityCardNumber", - "SKPersonalNumber", - "SITaxIdentificationNumber", - "SIUniqueMasterCitizenNumber", - "ZAIdentificationNumber", - "KRResidentRegistrationNumber", - "ESDNI", - "ESSocialSecurityNumber", - "ESTaxIdentificationNumber", - "SQLServerConnectionString", - "SENationalID", - "SENationalIDV2", - "SEPassportNumber", - "SETaxIdentificationNumber", - "SWIFTCode", - "CHSocialSecurityNumber", - "TWNationalID", - "TWPassportNumber", - "TWResidentCertificate", - "THPopulationIdentificationCode", - "TRNationalIdentificationNumber", - "UKDriversLicenseNumber", - "UKElectoralRollNumber", - "UKNationalHealthNumber", - "UKNationalInsuranceNumber", - "UKUniqueTaxpayerNumber", - "USUKPassportNumber", - "USBankAccountNumber", - "USDriversLicenseNumber", - "USIndividualTaxpayerIdentification", - "USSocialSecurityNumber", - "UAPassportNumberDomestic", - "UAPassportNumberInternational", - "Organization", - "Email", - "URL", - "Age", - "PhoneNumber", - "IPAddress", - "Date", - "Person", - "Address", - "All", - "Default" - ] - }, - "type": "array", - "uniqueItems": true - }, - "PiiCategoriesExclude": { - "description": "(Optional) describes the PII categories to return", - "items": { - "type": "string", - "x-ms-enum": { - "name": "PiiCategoriesExclude", - "modelAsString": true - }, - "enum": [ - "ABARoutingNumber", - "ARNationalIdentityNumber", - "AUBankAccountNumber", - "AUDriversLicenseNumber", - "AUMedicalAccountNumber", - "AUPassportNumber", - "AUTaxFileNumber", - "AUBusinessNumber", - "AUCompanyNumber", - "ATIdentityCard", - "ATTaxIdentificationNumber", - "ATValueAddedTaxNumber", - "AzureDocumentDBAuthKey", - "AzureIAASDatabaseConnectionAndSQLString", - "AzureIoTConnectionString", - "AzurePublishSettingPassword", - "AzureRedisCacheString", - "AzureSAS", - "AzureServiceBusString", - "AzureStorageAccountKey", - "AzureStorageAccountGeneric", - "BENationalNumber", - "BENationalNumberV2", - "BEValueAddedTaxNumber", - "BRCPFNumber", - "BRLegalEntityNumber", - "BRNationalIDRG", - "BGUniformCivilNumber", - "CABankAccountNumber", - "CADriversLicenseNumber", - "CAHealthServiceNumber", - "CAPassportNumber", - "CAPersonalHealthIdentification", - "CASocialInsuranceNumber", - "CLIdentityCardNumber", - "CNResidentIdentityCardNumber", - "CreditCardNumber", - "HRIdentityCardNumber", - "HRNationalIDNumber", - "HRPersonalIdentificationNumber", - "HRPersonalIdentificationOIBNumberV2", - "CYIdentityCard", - "CYTaxIdentificationNumber", - "CZPersonalIdentityNumber", - "CZPersonalIdentityV2", - "DKPersonalIdentificationNumber", - "DKPersonalIdentificationV2", - "DrugEnforcementAgencyNumber", - "EEPersonalIdentificationCode", - "EUDebitCardNumber", - "EUDriversLicenseNumber", - "EUGPSCoordinates", - "EUNationalIdentificationNumber", - "EUPassportNumber", - "EUSocialSecurityNumber", - "EUTaxIdentificationNumber", - "FIEuropeanHealthNumber", - "FINationalID", - "FINationalIDV2", - "FIPassportNumber", - "FRDriversLicenseNumber", - "FRHealthInsuranceNumber", - "FRNationalID", - "FRPassportNumber", - "FRSocialSecurityNumber", - "FRTaxIdentificationNumber", - "FRValueAddedTaxNumber", - "DEDriversLicenseNumber", - "DEPassportNumber", - "DEIdentityCardNumber", - "DETaxIdentificationNumber", - "DEValueAddedNumber", - "GRNationalIDCard", - "GRNationalIDV2", - "GRTaxIdentificationNumber", - "HKIdentityCardNumber", - "HUValueAddedNumber", - "HUPersonalIdentificationNumber", - "HUTaxIdentificationNumber", - "INPermanentAccount", - "INUniqueIdentificationNumber", - "IDIdentityCardNumber", - "InternationalBankingAccountNumber", - "IEPersonalPublicServiceNumber", - "IEPersonalPublicServiceNumberV2", - "ILBankAccountNumber", - "ILNationalID", - "ITDriversLicenseNumber", - "ITFiscalCode", - "ITValueAddedTaxNumber", - "JPBankAccountNumber", - "JPDriversLicenseNumber", - "JPPassportNumber", - "JPResidentRegistrationNumber", - "JPSocialInsuranceNumber", - "JPMyNumberCorporate", - "JPMyNumberPersonal", - "JPResidenceCardNumber", - "LVPersonalCode", - "LTPersonalCode", - "LUNationalIdentificationNumberNatural", - "LUNationalIdentificationNumberNonNatural", - "MYIdentityCardNumber", - "MTIdentityCardNumber", - "MTTaxIDNumber", - "NLCitizensServiceNumber", - "NLCitizensServiceNumberV2", - "NLTaxIdentificationNumber", - "NLValueAddedTaxNumber", - "NZBankAccountNumber", - "NZDriversLicenseNumber", - "NZInlandRevenueNumber", - "NZMinistryOfHealthNumber", - "NZSocialWelfareNumber", - "NOIdentityNumber", - "PHUnifiedMultiPurposeIDNumber", - "PLIdentityCard", - "PLNationalID", - "PLNationalIDV2", - "PLPassportNumber", - "PLTaxIdentificationNumber", - "PLREGONNumber", - "PTCitizenCardNumber", - "PTCitizenCardNumberV2", - "PTTaxIdentificationNumber", - "ROPersonalNumericalCode", - "RUPassportNumberDomestic", - "RUPassportNumberInternational", - "SANationalID", - "SGNationalRegistrationIdentityCardNumber", - "SKPersonalNumber", - "SITaxIdentificationNumber", - "SIUniqueMasterCitizenNumber", - "ZAIdentificationNumber", - "KRResidentRegistrationNumber", - "ESDNI", - "ESSocialSecurityNumber", - "ESTaxIdentificationNumber", - "SQLServerConnectionString", - "SENationalID", - "SENationalIDV2", - "SEPassportNumber", - "SETaxIdentificationNumber", - "SWIFTCode", - "CHSocialSecurityNumber", - "TWNationalID", - "TWPassportNumber", - "TWResidentCertificate", - "THPopulationIdentificationCode", - "TRNationalIdentificationNumber", - "UKDriversLicenseNumber", - "UKElectoralRollNumber", - "UKNationalHealthNumber", - "UKNationalInsuranceNumber", - "UKUniqueTaxpayerNumber", - "USUKPassportNumber", - "USBankAccountNumber", - "USDriversLicenseNumber", - "USIndividualTaxpayerIdentification", - "USSocialSecurityNumber", - "UAPassportNumberDomestic", - "UAPassportNumberInternational", - "Organization", - "Email", - "URL", - "Age", - "PhoneNumber", - "IPAddress", - "Date", - "Person", - "Address" - ] - }, - "type": "array", - "uniqueItems": true - }, - "ExtractiveSummarizationTaskParameters": { - "type": "object", - "description": "Supported parameters for an Extractive Summarization task.", - "properties": { - "sentenceCount": { - "type": "integer", - "default": 3, - "format": "int64" - }, - "sortBy": { - "$ref": "#/definitions/ExtractiveSummarizationSortingCriteria" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "ExtractiveSummarizationLROTask": { - "type": "object", - "description": "An object representing the task definition for an Extractive Summarization task.", - "properties": { - "parameters": { - "$ref": "#/definitions/ExtractiveSummarizationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "ExtractiveSummarization" - }, - "ExtractiveSummarizationResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "$ref": "#/definitions/ExtractedSummaryDocumentResultWithDetectedLanguage" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "ExtractiveSummarizationSortingCriteria": { - "type": "string", - "default": "Offset", - "description": "The sorting criteria to use for the results of Extractive Summarization.", - "enum": [ - "Offset", - "Rank" - ], - "x-ms-enum": { - "name": "ExtractiveSummarizationSortingCriteria", - "modelAsString": true, - "values": [ - { - "name": "Offset", - "description": "Indicates that results should be sorted in order of appearance in the text.", - "value": "Offset" - }, - { - "name": "Rank", - "description": "Indicates that results should be sorted in order of importance (i.e. rank score) according to the model.", - "value": "Rank" - } - ] - } - }, - "ExtractedSummaryDocumentResultWithDetectedLanguage": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ExtractedSummaryDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - }, - "ExtractedSummaryDocumentResult": { - "type": "object", - "properties": { - "sentences": { - "type": "array", - "description": "A ranked list of sentences representing the extracted summary.", - "items": { - "$ref": "#/definitions/ExtractedSummarySentence" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "sentences" - ] - }, - "ExtractedSummarySentence": { - "type": "object", - "required": [ - "text", - "rankScore", - "offset", - "length" - ], - "properties": { - "text": { - "type": "string", - "description": "The extracted sentence text." - }, - "rankScore": { - "type": "number", - "format": "double", - "description": "A double value representing the relevance of the sentence within the summary. Higher values indicate higher importance." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The sentence offset from the start of the document, based on the value of the parameter StringIndexType." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the sentence." - } - } - }, - "KeyPhraseTaskParameters": { - "type": "object", - "description": "Supported parameters for a Key Phrase Extraction task.", - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "KeyPhraseLROTask": { - "type": "object", - "description": "An object representing the task definition for a Key Phrase Extraction task.", - "properties": { - "parameters": { - "$ref": "#/definitions/KeyPhraseTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "KeyPhraseExtraction" - }, - "KeyPhraseTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/KeyPhraseResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "KeyPhraseExtractionResults" - }, - "KeyPhraseResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/KeyPhrasesDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "KeyPhrasesDocumentResult": { - "type": "object", - "properties": { - "keyPhrases": { - "type": "array", - "description": "A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.", - "items": { - "type": "string" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "keyPhrases" - ] - }, - "LanguageDetectionTaskParameters": { - "type": "object", - "description": "Supported parameters for a Language Detection task.", - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "LanguageDetectionTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/LanguageDetectionResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "LanguageDetectionResults" - }, - "LanguageDetectionResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "$ref": "#/definitions/LanguageDetectionDocumentResult" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "LanguageDetectionDocumentResult": { - "type": "object", - "properties": { - "detectedLanguage": { - "description": "Detected Language.", - "$ref": "#/definitions/DetectedLanguage" - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "detectedLanguage" - ] - }, - "DetectedLanguage": { - "type": "object", - "required": [ - "name", - "iso6391Name", - "confidenceScore" - ], - "properties": { - "name": { - "type": "string", - "description": "Long name of a detected language (e.g. English, French)." - }, - "iso6391Name": { - "type": "string", - "description": "A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr)." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true." - }, - "script": { - "type": "string", - "description": "Identifies the script of the input document.", - "enum": [ - "Latin" - ], - "x-ms-enum": { - "name": "ScriptKind", - "modelAsString": true - } - } - } - }, - "DynamicClassificationTaskParameters": { - "type": "object", - "description": "Supported parameters for a Zero Shot Classification task.", - "properties": { - "classificationType": { - "type": "string", - "description": "Specifies either one or multiple categories per document. Defaults to multi classification which may return more than one class for each document.", - "default": "Multi", - "enum": [ - "Single", - "Multi" - ], - "x-ms-enum": { - "name": "ClassificationType", - "modelAsString": true - } - }, - "categories": { - "type": "array", - "description": "a list of categories to which input is classified to.", - "items": { - "type": "string" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ], - "required": [ - "categories" - ] - }, - "DynamicClassificationTaskResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/DynamicClassificationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextTaskResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "DynamicClassificationResults" - }, - "DynamicClassificationResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "allOf": [ - { - "$ref": "#/definitions/DynamicClassificationDocumentResult" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "AnalyzeTextJobState": { - "allOf": [ - { - "$ref": "common.json#/definitions/JobState" - }, - { - "$ref": "#/definitions/TasksState" - }, - { - "$ref": "#/definitions/AnalyzeTextJobStatistics" - } - ] - }, - "Pagination": { - "properties": { - "nextLink": { - "type": "string" - } - }, - "type": "object" - }, - "AnalyzeTextJobStatistics": { - "properties": { - "statistics": { - "$ref": "common.json#/definitions/RequestStatistics" - } - }, - "type": "object" - }, - "TasksState": { - "properties": { - "tasks": { - "properties": { - "completed": { - "type": "integer", - "format": "int64" - }, - "failed": { - "type": "integer", - "format": "int64" - }, - "inProgress": { - "type": "integer", - "format": "int64" - }, - "total": { - "type": "integer", - "format": "int64" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - } - }, - "required": [ - "total", - "completed", - "failed", - "inProgress" - ], - "type": "object" - } - }, - "required": [ - "tasks" - ], - "type": "object" - }, - "TaskState": { - "properties": { - "lastUpdateDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "State" - } - } - }, - "required": [ - "status", - "lastUpdateDateTime" - ], - "type": "object" - }, - "AnalyzeTextLROResult": { - "type": "object", - "discriminator": "kind", - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeTextLROResultsKind" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskState" - }, - { - "$ref": "common.json#/definitions/TaskIdentifier" - } - ], - "required": [ - "kind" - ] - }, - "EntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityRecognitionLROResults" - }, - "CustomEntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomEntitiesResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomEntityRecognitionLROResults" - }, - "CustomSingleLabelClassificationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomLabelClassificationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomSingleLabelClassificationLROResults" - }, - "CustomMultiLabelClassificationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomLabelClassificationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomMultiLabelClassificationLROResults" - }, - "EntityLinkingLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/EntityLinkingResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "EntityLinkingLROResults" - }, - "PiiEntityRecognitionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/PiiResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "PiiEntityRecognitionLROResults" - }, - "ExtractiveSummarizationLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/ExtractiveSummarizationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "ExtractiveSummarizationLROResults" - }, - "HealthcareLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/HealthcareResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "HealthcareLROResults" - }, - "CustomHealthcareLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomHealthcareResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomHealthcareLROResults" - }, - "SentimentLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/SentimentResponse" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "SentimentAnalysisLROResults" - }, - "CustomSentimentAnalysisLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/CustomSentimentAnalysisResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomSentimentAnalysisLROResults" - }, - "KeyPhraseExtractionLROResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/KeyPhraseResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "KeyPhraseExtractionLROResults" - }, - "DocumentResponse": { - "type": "object", - "properties": {} - }, - "DocumentResult": { - "type": "object", - "required": [ - "id", - "warnings" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique, non-empty document identifier." - }, - "warnings": { - "type": "array", - "description": "Warnings encountered while processing document.", - "items": { - "$ref": "#/definitions/DocumentWarning" - } - }, - "statistics": { - "description": "if showStats=true was specified in the request this field will contain information about the document payload.", - "$ref": "#/definitions/DocumentStatistics" - } - } - }, - "DocumentDetectedLanguage": { - "type": "object", - "properties": { - "detectedLanguage": { - "$ref": "#/definitions/DetectedLanguage", - "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." - } - } - }, - "DocumentWarning": { - "type": "object", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "LongWordsInDocument", - "DocumentTruncated" - ], - "x-ms-enum": { - "name": "WarningCodeValue", - "modelAsString": true - }, - "description": "Error code." - }, - "message": { - "type": "string", - "description": "Warning message." - }, - "targetRef": { - "type": "string", - "description": "A JSON pointer reference indicating the target object." - } - } - }, - "DocumentStatistics": { - "type": "object", - "required": [ - "charactersCount", - "transactionsCount" - ], - "properties": { - "charactersCount": { - "type": "integer", - "format": "int32", - "description": "Number of text elements recognized in the document." - }, - "transactionsCount": { - "type": "integer", - "format": "int32", - "description": "Number of transactions for the document." - } - }, - "description": "if showStats=true was specified in the request this field will contain information about the document payload." - }, - "DocumentRequestStatistics": { - "type": "object", - "required": [ - "documentsCount", - "validDocumentsCount", - "erroneousDocumentsCount" - ], - "properties": { - "documentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of documents submitted in the request." - }, - "validDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." - }, - "erroneousDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/RequestStatistics" - } - ], - "description": "if showStats=true was specified in the request this field will contain information about the document request payload." - }, - "MultiLanguageInput": { - "type": "object", - "description": "Contains an input document to be analyzed by the service.", - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "A unique, non-empty document identifier." - }, - "text": { - "type": "string", - "description": "The input text to process." - }, - "language": { - "type": "string", - "description": "(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. For Auto Language Detection, use \"auto\". If not set, use \"en\" for English as default." - } - } - }, - "LanguageInput": { - "type": "object", - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique, non-empty document identifier." - }, - "text": { - "type": "string" - }, - "countryHint": { - "type": "string" - } - } - }, - "AbstractiveSummarizationLROTask": { - "type": "object", - "description": "An object representing the task definition for an Abstractive Summarization task.", - "required": [ - "parameters" - ], - "properties": { - "parameters": { - "$ref": "#/definitions/AbstractiveSummarizationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "AbstractiveSummarization" - }, - "CustomAbstractiveSummarizationLROTask": { - "type": "object", - "description": "An object representing the task definition for an Custom Abstractive Summarization task.", - "required": [ - "parameters" - ], - "properties": { - "parameters": { - "$ref": "#/definitions/CustomAbstractiveSummarizationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROTask" - } - ], - "x-ms-discriminator-value": "CustomAbstractiveSummarization" - }, - "AbstractiveSummarizationTaskParameters": { - "type": "object", - "description": "Supported parameters for the pre-build Abstractive Summarization task.", - "allOf": [ - { - "$ref": "common.json#/definitions/AbstractiveSummarizationTaskParametersBase" - }, - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "CustomAbstractiveSummarizationTaskParameters": { - "type": "object", - "description": "Supported parameters for the Custom Abstractive Summarization task.", - "allOf": [ - { - "$ref": "common.json#/definitions/AbstractiveSummarizationTaskParametersBase" - }, - { - "$ref": "common.json#/definitions/CustomTaskParameters" - } - ] - }, - "AbstractiveSummarizationLROResult": { - "type": "object", - "description": "An object representing the results for an Abstractive Summarization task.", - "properties": { - "results": { - "$ref": "#/definitions/AbstractiveSummarizationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "AbstractiveSummarizationLROResults" - }, - "CustomAbstractiveSummarizationLROResult": { - "type": "object", - "description": "An object representing the results for an Custom Abstractive Summarization task.", - "properties": { - "results": { - "$ref": "#/definitions/CustomAbstractiveSummarizationResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeTextLROResult" - } - ], - "required": [ - "results" - ], - "x-ms-discriminator-value": "CustomAbstractiveSummarizationLROResults" - }, - "AbstractiveSummarizationResultBase": { - "type": "object", - "description": "An object representing the summarization results of each document.", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "$ref": "#/definitions/AbstractiveSummaryDocumentResultWithDetectedLanguage" - } - } - }, - "required": [ - "documents" - ] - }, - "AbstractiveSummaryDocumentResultWithDetectedLanguage": { - "type": "object", - "description": "An object representing the summarization result of a single document with detected language.", - "allOf": [ - { - "$ref": "#/definitions/AbstractiveSummaryDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - }, - "AbstractiveSummarizationResult": { - "type": "object", - "description": "An object representing the pre-build summarization results of each document.", - "allOf": [ - { - "$ref": "#/definitions/AbstractiveSummarizationResultBase" - }, - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "CustomAbstractiveSummarizationResult": { - "type": "object", - "description": "An object representing the custom summarization results of each document.", - "allOf": [ - { - "$ref": "#/definitions/AbstractiveSummarizationResultBase" - }, - { - "$ref": "common.json#/definitions/CustomResult" - } - ], - "required": [ - "documents" - ] - }, - "AbstractiveSummaryDocumentResult": { - "type": "object", - "description": "An object representing the summarization result of a single document.", - "properties": { - "summaries": { - "type": "array", - "description": "A list of abstractive summaries.", - "items": { - "$ref": "#/definitions/AbstractiveSummary" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - } - ], - "required": [ - "summaries" - ] - }, - "AbstractiveSummary": { - "type": "object", - "description": "An object representing a single summary with context for given document.", - "properties": { - "text": { - "type": "string", - "description": "The text of the summary." - }, - "contexts": { - "type": "array", - "description": "The context list of the summary.", - "items": { - "$ref": "common.json#/definitions/SummaryContext" - } - } - }, - "required": [ - "text" - ] - } - }, - "parameters": {} -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/common.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/common.json deleted file mode 100644 index 083c921a08a5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/common.json +++ /dev/null @@ -1,1025 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2023-04-15-preview" - }, - "paths": {}, - "definitions": { - "ErrorResponse": { - "type": "object", - "description": "Error response.", - "additionalProperties": false, - "properties": { - "error": { - "description": "The error object.", - "$ref": "#/definitions/Error" - } - }, - "required": [ - "error" - ] - }, - "Error": { - "type": "object", - "description": "The error object.", - "additionalProperties": true, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/ErrorCode" - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - }, - "target": { - "type": "string", - "description": "The target of the error." - }, - "details": { - "type": "array", - "description": "An array of details about specific errors that led to this reported error.", - "items": { - "$ref": "#/definitions/Error" - } - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "InnerErrorModel": { - "type": "object", - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", - "additionalProperties": false, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "$ref": "#/definitions/InnerErrorCode" - }, - "message": { - "type": "string", - "description": "Error message." - }, - "details": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Error details." - }, - "target": { - "type": "string", - "description": "Error target." - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerErrorModel" - } - } - }, - "ErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "ErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidArgument", - "Unauthorized", - "Forbidden", - "NotFound", - "ProjectNotFound", - "OperationNotFound", - "AzureCognitiveSearchNotFound", - "AzureCognitiveSearchIndexNotFound", - "TooManyRequests", - "AzureCognitiveSearchThrottling", - "AzureCognitiveSearchIndexLimitReached", - "InternalServerError", - "ServiceUnavailable", - "Timeout", - "QuotaExceeded", - "Conflict", - "Warning" - ] - }, - "InnerErrorCode": { - "type": "string", - "description": "Human-readable error code.", - "x-ms-enum": { - "name": "InnerErrorCode", - "modelAsString": true - }, - "enum": [ - "InvalidRequest", - "InvalidParameterValue", - "KnowledgeBaseNotFound", - "AzureCognitiveSearchNotFound", - "AzureCognitiveSearchThrottling", - "ExtractionFailure", - "InvalidRequestBodyFormat", - "EmptyRequest", - "MissingInputDocuments", - "InvalidDocument", - "ModelVersionIncorrect", - "InvalidDocumentBatch", - "UnsupportedLanguageCode", - "InvalidCountryHint" - ] - }, - "Language": { - "type": "string", - "description": "Language of the text records. This is BCP-47 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." - }, - "RedactionCharacter": { - "type": "string", - "description": "Optional parameter to use a Custom Character to be used for redaction in PII responses. Default character will be * as before. We allow specific ascii characters for redaction.", - "default": "*", - "x-ms-enum": { - "name": "redactionCharacter", - "modelAsString": true - }, - "enum": [ - "!", - "#", - "$", - "%", - "&", - "*", - "+", - "-", - "=", - "?", - "@", - "^", - "_", - "~" - ] - }, - "StringIndexType": { - "type": "string", - "description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.", - "default": "TextElements_v8", - "enum": [ - "TextElements_v8", - "UnicodeCodePoint", - "Utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "TextElements_v8", - "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." - }, - { - "value": "UnicodeCodePoint", - "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." - }, - { - "value": "Utf16CodeUnit", - "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - } - }, - "TaskState": { - "description": "Returns the current state of the task.", - "properties": { - "lastUpdateDateTime": { - "description": "The last updated time in UTC for the task.", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The status of the task at the mentioned last update time.", - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "State" - } - } - }, - "required": [ - "status", - "lastUpdateDateTime" - ], - "type": "object" - }, - "TaskIdentifier": { - "type": "object", - "description": "Base task object.", - "properties": { - "taskName": { - "type": "string" - } - } - }, - "TaskParameters": { - "type": "object", - "description": "Base parameters object for a text analysis task.", - "properties": { - "loggingOptOut": { - "type": "boolean", - "default": false - } - } - }, - "PreBuiltTaskParameters": { - "type": "object", - "description": "Parameters object for a text analysis task using pre-built models.", - "properties": { - "modelVersion": { - "type": "string", - "default": "latest" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - } - ] - }, - "JobState": { - "properties": { - "displayName": { - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "type": "string" - }, - "jobId": { - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { - "enum": [ - "notStarted", - "running", - "succeeded", - "partiallyCompleted", - "failed", - "cancelled", - "cancelling" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "State" - } - }, - "errors": { - "items": { - "$ref": "#/definitions/Error" - }, - "type": "array" - }, - "nextLink": { - "type": "string" - } - }, - "required": [ - "jobId", - "lastUpdatedDateTime", - "createdDateTime", - "status" - ] - }, - "JobErrors": { - "properties": { - "errors": { - "items": { - "$ref": "#/definitions/Error" - }, - "type": "array" - } - }, - "type": "object" - }, - "InputError": { - "type": "object", - "description": "Contains details of errors encountered during a job execution.", - "required": [ - "id", - "error" - ], - "properties": { - "id": { - "type": "string", - "description": "The ID of the input." - }, - "error": { - "type": "object", - "description": "Error encountered.", - "$ref": "#/definitions/Error" - } - } - }, - "InputWarning": { - "type": "object", - "description": "Contains details of warnings encountered during a job execution.", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "description": "Warning code." - }, - "message": { - "type": "string", - "description": "Warning message." - }, - "targetRef": { - "type": "string", - "description": "A JSON pointer reference indicating the target object." - } - } - }, - "RequestStatistics": { - "type": "object", - "required": [ - "documentsCount", - "validDocumentsCount", - "erroneousDocumentsCount", - "transactionsCount" - ], - "properties": { - "documentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of documents submitted in the request." - }, - "validDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." - }, - "erroneousDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." - }, - "transactionsCount": { - "type": "integer", - "format": "int64", - "description": "Number of transactions for the request." - } - }, - "additionalProperties": true, - "description": "if showStats=true was specified in the request this field will contain information about the request payload." - }, - "PreBuiltResult": { - "type": "object", - "properties": { - "errors": { - "type": "array", - "description": "Errors by document id.", - "items": { - "$ref": "#/definitions/InputError" - } - }, - "statistics": { - "$ref": "#/definitions/RequestStatistics" - }, - "modelVersion": { - "type": "string", - "description": "This field indicates which model is used for scoring." - } - }, - "required": [ - "errors", - "modelVersion" - ] - }, - "AnswersResult": { - "type": "object", - "description": "Represents List of Question Answers.", - "additionalProperties": false, - "properties": { - "answers": { - "type": "array", - "description": "Represents Answer Result list.", - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswer" - } - } - } - }, - "KnowledgeBaseAnswer": { - "type": "object", - "description": "Represents knowledge base answer.", - "additionalProperties": false, - "properties": { - "questions": { - "type": "array", - "description": "List of questions associated with the answer.", - "items": { - "type": "string" - } - }, - "answer": { - "type": "string", - "description": "Answer text." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidence", - "description": "Answer confidence score, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "id": { - "type": "integer", - "x-ms-client-name": "qnaId", - "description": "ID of the QnA result.", - "format": "int32" - }, - "source": { - "type": "string", - "description": "Source of QnA result." - }, - "metadata": { - "type": "object", - "description": "Metadata associated with the answer, useful to categorize or filter question answers.", - "additionalProperties": { - "type": "string" - } - }, - "dialog": { - "type": "object", - "$ref": "#/definitions/KnowledgeBaseAnswerDialog" - }, - "answerSpan": { - "type": "object", - "x-ms-client-name": "shortAnswer", - "description": "Answer span object of QnA with respect to user's question.", - "$ref": "#/definitions/AnswerSpan" - } - } - }, - "KnowledgeBaseAnswerDialog": { - "type": "object", - "description": "Dialog associated with Answer.", - "properties": { - "isContextOnly": { - "type": "boolean", - "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as search result for queries without context; otherwise, if false, ignores context and includes this QnA in search result." - }, - "prompts": { - "type": "array", - "description": "List of prompts associated with the answer.", - "maxItems": 20, - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswerPrompt" - } - } - } - }, - "KnowledgeBaseAnswerPrompt": { - "type": "object", - "description": "Prompt for an answer.", - "properties": { - "displayOrder": { - "type": "integer", - "description": "Index of the prompt - used in ordering of the prompts.", - "format": "int32" - }, - "qnaId": { - "type": "integer", - "description": "QnA ID corresponding to the prompt.", - "format": "int32" - }, - "displayText": { - "type": "string", - "description": "Text displayed to represent a follow up question prompt.", - "maxLength": 200 - } - } - }, - "AnswerSpan": { - "type": "object", - "description": "Answer span object of QnA.", - "additionalProperties": false, - "properties": { - "text": { - "type": "string", - "description": "Predicted text of answer span." - }, - "confidenceScore": { - "type": "number", - "x-ms-client-name": "confidence", - "description": "Predicted score of answer span, value ranges from 0 to 1.", - "format": "double", - "maximum": 1, - "minimum": 0 - }, - "offset": { - "type": "integer", - "description": "The answer span offset from the start of answer.", - "format": "int32" - }, - "length": { - "type": "integer", - "description": "The length of the answer span.", - "format": "int32" - } - } - }, - "AnswersOptions": { - "type": "object", - "description": "Parameters to query a knowledge base.", - "additionalProperties": false, - "properties": { - "qnaId": { - "type": "integer", - "description": "Exact QnA ID to fetch from the knowledge base, this field takes priority over question.", - "format": "int32" - }, - "question": { - "type": "string", - "description": "User question to query against the knowledge base." - }, - "top": { - "type": "integer", - "description": "Max number of answers to be returned for the question.", - "format": "int32" - }, - "userId": { - "type": "string", - "description": "Unique identifier for the user." - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidenceThreshold", - "description": "Minimum threshold score for answers, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "context": { - "x-ms-client-name": "answerContext", - "description": "Context object with previous QnA's information.", - "$ref": "#/definitions/KnowledgeBaseAnswerContext" - }, - "rankerType": { - "type": "string", - "x-ms-client-name": "rankerKind", - "description": "Type of ranker to be used.", - "x-ms-enum": { - "name": "RankerKind", - "modelAsString": true, - "values": [ - { - "value": "QuestionOnly", - "description": "Question only ranker." - }, - { - "value": "Default", - "description": "Default ranker." - } - ] - }, - "enum": [ - "Default", - "QuestionOnly" - ] - }, - "filters": { - "description": "Filter QnAs based on given metadata list and knowledge base sources.", - "$ref": "#/definitions/QueryFilters" - }, - "answerSpanRequest": { - "x-ms-client-name": "shortAnswerOptions", - "description": "To configure Answer span prediction feature.", - "$ref": "#/definitions/ShortAnswerOptions" - }, - "includeUnstructuredSources": { - "type": "boolean", - "description": "(Optional) Flag to enable Query over Unstructured Sources." - } - } - }, - "KnowledgeBaseAnswerContext": { - "type": "object", - "description": "Context object with previous QnA's information.", - "additionalProperties": false, - "required": [ - "previousQnaId" - ], - "properties": { - "previousQnaId": { - "type": "integer", - "description": "Previous turn top answer result QnA ID.", - "format": "int32" - }, - "previousUserQuery": { - "type": "string", - "x-ms-client-name": "previousQuestion", - "description": "Previous user query." - } - } - }, - "QueryFilters": { - "type": "object", - "description": "filters over knowledge base.", - "additionalProperties": false, - "properties": { - "metadataFilter": { - "type": "object", - "$ref": "#/definitions/MetadataFilter" - }, - "sourceFilter": { - "type": "object", - "$ref": "#/definitions/SourceFilter" - }, - "logicalOperation": { - "type": "string", - "description": "Logical operation used to join metadata filter with source filter.", - "$ref": "#/definitions/LogicalOperationKind", - "default": "AND" - } - } - }, - "MetadataFilter": { - "type": "object", - "description": "Find QnAs that are associated with the given list of metadata.", - "additionalProperties": false, - "properties": { - "metadata": { - "type": "array", - "items": { - "$ref": "#/definitions/MetadataRecord" - } - }, - "logicalOperation": { - "type": "string", - "description": "Operation used to join metadata filters.", - "$ref": "#/definitions/LogicalOperationKind", - "default": "AND" - } - } - }, - "MetadataRecord": { - "type": "object", - "description": "Object to provide the key value pair for each metadata.", - "additionalProperties": false, - "required": [ - "key", - "value" - ], - "properties": { - "key": { - "type": "string", - "description": "Metadata Key from Metadata dictionary used in the QnA." - }, - "value": { - "type": "string", - "description": "Metadata Value from Metadata dictionary used in the QnA." - } - } - }, - "SourceFilter": { - "type": "array", - "description": "Find QnAs that are associated with any of the given list of sources in knowledge base.", - "items": { - "type": "string" - } - }, - "LogicalOperationKind": { - "type": "string", - "description": "Set to 'OR' or 'AND' for using corresponding logical operation.", - "x-ms-enum": { - "name": "LogicalOperationKind", - "modelAsString": true - }, - "enum": [ - "AND", - "OR" - ] - }, - "ShortAnswerOptions": { - "type": "object", - "description": "To configure Answer span prediction feature.", - "additionalProperties": false, - "required": [ - "enable" - ], - "properties": { - "enable": { - "type": "boolean", - "description": "Enable or disable Answer Span prediction.", - "enum": [ - true - ], - "x-ms-enum": { - "name": "enable", - "modelAsString": false - } - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidenceThreshold", - "description": "Minimum threshold score required to include an answer span, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "topAnswersWithSpan": { - "type": "integer", - "x-ms-client-name": "top", - "description": "Number of Top answers to be considered for span prediction from 1 to 10.", - "format": "int32", - "maximum": 10, - "minimum": 1 - } - } - }, - "Sentiment": { - "type": "string", - "description": "Predicted sentiment.", - "enum": [ - "positive", - "neutral", - "negative", - "mixed" - ], - "x-ms-enum": { - "name": "TextSentiment", - "modelAsString": true, - "values": [ - { - "value": "positive", - "description": "Positive sentiment." - }, - { - "value": "neutral", - "description": "Neutral sentiment." - }, - { - "value": "negative", - "description": "Negative sentiment." - }, - { - "value": "mixed", - "description": "Mixed sentiment." - } - ] - } - }, - "SentimentConfidenceScores": { - "type": "object", - "required": [ - "positive", - "neutral", - "negative" - ], - "properties": { - "positive": { - "type": "number", - "format": "double", - "description": "Confidence score for positive sentiment" - }, - "neutral": { - "type": "number", - "format": "double", - "description": "Confidence score for neutral sentiment" - }, - "negative": { - "type": "number", - "format": "double", - "description": "Confidence score for negative sentiment" - } - }, - "description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative." - }, - "AbstractiveSummarizationTaskParametersBase": { - "type": "object", - "description": "Supported parameters for an Abstractive Summarization task.", - "properties": { - "sentenceCount": { - "type": "integer", - "format": "int32", - "description": "It controls the approximate number of sentences in the output summaries." - }, - "stringIndexType": { - "$ref": "#/definitions/StringIndexType" - } - } - }, - "SummaryContext": { - "type": "object", - "description": "The context of the summary.", - "required": [ - "offset", - "length" - ], - "properties": { - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the context. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the context. Use of different 'stringIndexType' values can affect the length returned." - } - } - }, - "CustomTaskParameters": { - "type": "object", - "description": "Parameters object for a text analysis task using custom models.", - "properties": { - "projectName": { - "type": "string", - "description": "This field indicates the project name for the model." - }, - "deploymentName": { - "type": "string", - "description": "This field indicates the deployment name for the model." - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskParameters" - } - ], - "required": [ - "projectName", - "deploymentName" - ] - }, - "CustomResult": { - "type": "object", - "properties": { - "errors": { - "type": "array", - "description": "Errors by document id.", - "items": { - "$ref": "#/definitions/DocumentError" - } - }, - "statistics": { - "$ref": "#/definitions/RequestStatistics" - }, - "projectName": { - "type": "string", - "description": "This field indicates the project name for the model." - }, - "deploymentName": { - "type": "string", - "description": "This field indicates the deployment name for the model." - } - }, - "required": [ - "errors", - "projectName", - "deploymentName" - ] - }, - "DocumentError": { - "type": "object", - "required": [ - "id", - "error" - ], - "properties": { - "id": { - "type": "string", - "description": "Document Id." - }, - "error": { - "type": "object", - "description": "Document Error.", - "$ref": "#/definitions/Error" - } - } - } - }, - "parameters": { - "Endpoint": { - "name": "endpoint", - "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "format": "url", - "in": "path", - "x-ms-skip-url-encoding": true - }, - "ProjectNameQueryParameter": { - "name": "projectName", - "in": "query", - "required": true, - "type": "string", - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "ProjectNamePathParameter": { - "name": "projectName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 100, - "description": "The name of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNameQueryParameter": { - "name": "deploymentName", - "in": "query", - "required": true, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "DeploymentNamePathParameter": { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the specific deployment of the project to use.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - }, - "TopParameter": { - "name": "top", - "in": "query", - "description": "The maximum number of resources to return from the collection.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "SkipParameter": { - "name": "skip", - "in": "query", - "description": "An offset into the collection of the first resource to be returned.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "MaxPageSizeParameter": { - "name": "maxpagesize", - "in": "query", - "description": "The maximum number of resources to include in a single response.", - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "ShowStats": { - "name": "showStats", - "in": "query", - "description": "(Optional) if set to true, response will contain request and document level statistics.", - "type": "boolean", - "required": false, - "x-ms-parameter-location": "method" - }, - "JobId": { - "description": "Job ID", - "format": "uuid", - "in": "path", - "name": "jobId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json deleted file mode 100644 index d65685049f4b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_AssignDeploymentResources", - "title": "Successful Assign Deployment Resources", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "body": { - "resourcesMetadata": [ - { - "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "customDomain": "lang-test-weu.cognitiveservices.azure.com", - "region": "westeurope" - }, - { - "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", - "customDomain": "lang-test-eus.cognitiveservices.azure.com", - "region": "eastus" - } - ] - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/resources/assign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json deleted file mode 100644 index 2e6ebcae37e7..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_CancelTrainingJob", - "title": "Successful Cancel Training Job", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json deleted file mode 100644 index 289861b1a753..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_CopyProject", - "title": "Successful Copy Project", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "body": { - "projectKind": "Conversation", - "targetProjectName": "EmailApp", - "accessToken": "103fcb47-b095-44c1-aedd-4024a5923275", - "expiresAt": "2023-04-18T13:53:03Z", - "targetResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "targetResourceRegion": "westeurope" - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/copy/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json deleted file mode 100644 index 06375ea84def..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_CopyProjectAuthorization", - "title": "Successful Copy Project Authorization", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "body": { - "projectKind": "Conversation", - "allowOverwrite": false - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "projectKind": "Conversation", - "targetProjectName": "EmailApp", - "accessToken": "103fcb47-b095-44c1-aedd-4024a5923275", - "expiresAt": "2023-04-18T13:53:03Z", - "targetResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "targetResourceRegion": "westeurope" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json deleted file mode 100644 index 5a3d614c0ffa..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_CreateProject", - "title": "Successful Create Project", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/merge-patch+json", - "api-version": "2023-04-15-preview", - "projectName": "myproject", - "body": { - "projectName": "myproject", - "language": "en", - "projectKind": "Conversation", - "description": "This is a sample conversation project.", - "multilingual": false - } - }, - "responses": { - "201": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "projectKind": "Conversation", - "projectName": "myproject", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - } - }, - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "Conversation", - "projectName": "myproject", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json deleted file mode 100644 index ac085b0a51ef..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "ConversationAuthoringDeployment_DeleteDeployment", - "title": "Successful Delete Deployment", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "deploymentName": "staging" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json deleted file mode 100644 index 5ecda1fd3876..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "ConversationAuthoringDeployment_DeleteDeploymentFromResources", - "title": "Successful Delete Deployment From Resources", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "deploymentName": "staging", - "body": { - "assignedResourceIds": [ - "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" - ] - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/delete-from-resources/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json deleted file mode 100644 index a6882ba54a17..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "ConversationAuthoringTrainedModel_DeleteTrainedModel", - "title": "Successful Delete Model", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model2" - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json deleted file mode 100644 index 77d01d831726..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_DeleteProject", - "title": "Successful Delete Project", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "myproject" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json deleted file mode 100644 index e99cc1835426..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "operationId": "ConversationAuthoringDeployment_DeployProject", - "title": "Successful Deploy Project", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "deploymentName": "production", - "body": { - "trainedModelLabel": "29886710a2ae49259d62cffca977db66", - "assignedResourceIds": [ - "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus" - ] - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json deleted file mode 100644 index 53647782c64b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "ConversationAuthoringTrainedModel_EvaluateModel", - "title": "Successful Evaluation Project", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1", - "body": { - "kind": "percentage", - "testingSplitPercentage": 20, - "trainingSplitPercentage": 80 - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/models/model1/evaluate/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json deleted file mode 100644 index 5fd5108392af..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_Export", - "title": "Successful Export Project", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "stringIndexType": "Utf16CodeUnit" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json deleted file mode 100644 index 2f927b9e6b2f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_GetAssignDeploymentResourcesStatus", - "title": "Successful Get Assign Deployment Resources Status", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json deleted file mode 100644 index 606c84b78809..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_GetCopyProjectStatus", - "title": "Successful Get Copy Project Status", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json deleted file mode 100644 index 04fda0dc0eca..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "operationId": "ConversationAuthoringDeployment_GetDeployment", - "title": "Successful Get Deployment", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "deploymentName": "staging" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "deploymentName": "staging", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T15:53:04Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-15-preview", - "assignedResources": [ - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "region": "westeurope" - }, - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", - "region": "eastus" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json deleted file mode 100644 index 54b00495ea62..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "ConversationAuthoringDeployment_GetDeploymentDeleteFromResourcesStatus", - "title": "Successful Get Deployment Status", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "deploymentName": "production", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json deleted file mode 100644 index 55a103ec50fe..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "ConversationAuthoringDeployment_GetDeploymentStatus", - "title": "Successful Get Deployment Status", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "deploymentName": "production", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json deleted file mode 100644 index 087e733326f5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "operationId": "ConversationAuthoringTrainedModel_GetEvaluationStatus", - "title": "Successful Get Evaluation Status", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "result": { - "evaluationOptions": { - "kind": "percentage", - "trainingSplitPercentage": 60, - "testingSplitPercentage": 40 - }, - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "percentComplete": 30 - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:45:48Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "running" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json deleted file mode 100644 index 766f30cf5038..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_GetExportStatus", - "title": "Successful Get Export Status", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "resultUrl": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2023-04-15-preview", - "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", - "createdDateTime": "2022-04-18T15:23:07Z", - "lastUpdatedDateTime": "2022-04-18T15:23:08Z", - "expirationDateTime": "2022-04-25T15:23:07Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json deleted file mode 100644 index 38f5a1514d69..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_GetImportStatus", - "title": "Successful Get Import Status", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", - "createdDateTime": "2022-04-18T15:17:20Z", - "lastUpdatedDateTime": "2022-04-18T15:17:22Z", - "expirationDateTime": "2022-04-25T15:17:20Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json deleted file mode 100644 index b091657770fc..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "ConversationAuthoringTrainedModel_GetLoadSnapshotStatus", - "title": "Successful Get Load Snapshot Status", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:45:48Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "running" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json deleted file mode 100644 index 4df5bc45e0e6..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "operationId": "ConversationAuthoringTrainedModel_GetTrainedModel", - "title": "Successful Get Model", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "label": "model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49Z", - "lastTrainingDurationInSeconds": 186, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01", - "hasSnapshot": true - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json deleted file mode 100644 index 027cfa770b17..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json +++ /dev/null @@ -1,286 +0,0 @@ -{ - "operationId": "ConversationAuthoringTrainedModel_GetModelEvaluationResults", - "title": "Successful Get Model Evaluation", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1", - "stringIndexType": "Utf16CodeUnit", - "maxpagesize": 10 - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "text": "send the email", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [], - "predictedEntities": [] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "send a mail to daniel", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 15, - "length": 6 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 15, - "length": 6 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "i forgot to add an important part to that email to james . please set it up to edit", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 51, - "length": 5 - } - ], - "predictedEntities": [ - { - "category": "Category", - "offset": 19, - "length": 9 - }, - { - "category": "ContactName", - "offset": 51, - "length": 5 - } - ] - }, - "intentsResult": { - "expectedIntent": "AddMore", - "predictedIntent": "AddMore" - } - }, - { - "text": "send email to a and tian", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 14, - "length": 1 - }, - { - "category": "ContactName", - "offset": 20, - "length": 4 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 14, - "length": 1 - }, - { - "category": "ContactName", - "offset": 20, - "length": 4 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "send thomas an email", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 5, - "length": 6 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 5, - "length": 6 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "i need to add more to the email message i am sending to vincent", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 56, - "length": 7 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 56, - "length": 7 - } - ] - }, - "intentsResult": { - "expectedIntent": "AddMore", - "predictedIntent": "AddMore" - } - }, - { - "text": "send an email to lily roth and abc123@microsoft.com", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 17, - "length": 9 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 17, - "length": 9 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "i need to add something else to my email to cheryl", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 44, - "length": 6 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 44, - "length": 6 - } - ] - }, - "intentsResult": { - "expectedIntent": "AddMore", - "predictedIntent": "AddMore" - } - }, - { - "text": "send an email to larry , joseph and billy larkson", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 17, - "length": 5 - }, - { - "category": "ContactName", - "offset": 25, - "length": 6 - }, - { - "category": "ContactName", - "offset": 36, - "length": 13 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 17, - "length": 5 - }, - { - "category": "ContactName", - "offset": 25, - "length": 6 - }, - { - "category": "ContactName", - "offset": 36, - "length": 13 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - }, - { - "text": "send mail to dorothy", - "language": "en-us", - "entitiesResult": { - "expectedEntities": [ - { - "category": "ContactName", - "offset": 13, - "length": 7 - } - ], - "predictedEntities": [ - { - "category": "ContactName", - "offset": 13, - "length": 7 - } - ] - }, - "intentsResult": { - "expectedIntent": "SendEmail", - "predictedIntent": "SendEmail" - } - } - ], - "nextLink": "https://api.example.com/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2023-04-15-preview&top=2147483637&skip=100&maxpagesize=100" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json deleted file mode 100644 index b2fdeafd2727..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json +++ /dev/null @@ -1,528 +0,0 @@ -{ - "operationId": "ConversationAuthoringTrainedModel_GetModelEvaluationSummary", - "title": "Successful Get Model Evaluation Summary", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "entitiesEvaluation": { - "confusionMatrix": { - "Attachment": { - "Attachment": { - "normalizedValue": 100.0, - "rawValue": 3.0 - } - }, - "Category": { - "Category": { - "normalizedValue": 91.666664, - "rawValue": 11.0 - }, - "$none": { - "normalizedValue": 8.333333, - "rawValue": 1.0 - } - }, - "ContactName": { - "ContactName": { - "normalizedValue": 91.666664, - "rawValue": 22.0 - }, - "SenderName": { - "normalizedValue": 4.1666665, - "rawValue": 1.0 - }, - "$none": { - "normalizedValue": 4.1666665, - "rawValue": 1.0 - } - }, - "Date": { - "Date": { - "normalizedValue": 100.0, - "rawValue": 2.0 - } - }, - "EmailSubject": { - "EmailSubject": { - "normalizedValue": 93.33333, - "rawValue": 9.333334 - }, - "$none": { - "normalizedValue": 6.6666665, - "rawValue": 0.6666667 - } - }, - "FromRelationshipName": { - "FromRelationshipName": { - "normalizedValue": 100.0, - "rawValue": 1.0 - } - }, - "Line": { - "Line": { - "normalizedValue": 100.0, - "rawValue": 2.0 - } - }, - "Message": { - "Message": { - "normalizedValue": 81.2063, - "rawValue": 6.496504 - }, - "EmailSubject": { - "normalizedValue": 7.43007, - "rawValue": 0.5944056 - }, - "$none": { - "normalizedValue": 9.120047, - "rawValue": 0.7296037 - }, - "Date": { - "normalizedValue": 2.2435899, - "rawValue": 0.17948718 - } - }, - "OrderReference": { - "OrderReference": { - "normalizedValue": 100.0, - "rawValue": 17.0 - } - }, - "PositionReference": { - "$none": { - "normalizedValue": 100.0, - "rawValue": 1.0 - } - }, - "RelationshipName": { - "RelationshipName": { - "normalizedValue": 66.666664, - "rawValue": 2.0 - }, - "$none": { - "normalizedValue": 33.333332, - "rawValue": 1.0 - } - }, - "SearchTexts": { - "SearchTexts": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "SenderName": { - "SenderName": { - "normalizedValue": 88.888885, - "rawValue": 8.0 - }, - "ContactName": { - "normalizedValue": 11.111111, - "rawValue": 1.0 - } - }, - "Time": { - "$none": { - "normalizedValue": 100.0, - "rawValue": 2.0 - } - }, - "$none": { - "$none": { - "normalizedValue": 99.739265, - "rawValue": 162.575 - }, - "Category": { - "normalizedValue": 0.2607362, - "rawValue": 0.425 - } - } - }, - "entities": { - "ContactName": { - "f1": 0.9361702799797058, - "precision": 0.95652174949646, - "recall": 0.9166666865348816, - "truePositiveCount": 22, - "trueNegativeCount": 0, - "falsePositiveCount": 1, - "falseNegativeCount": 2 - }, - "Category": { - "f1": 0.8799999952316284, - "precision": 0.8461538553237915, - "recall": 0.9166666865348816, - "truePositiveCount": 11, - "trueNegativeCount": 0, - "falsePositiveCount": 2, - "falseNegativeCount": 1 - }, - "SenderName": { - "f1": 0.8888888955116272, - "precision": 0.8888888955116272, - "recall": 0.8888888955116272, - "truePositiveCount": 8, - "trueNegativeCount": 0, - "falsePositiveCount": 1, - "falseNegativeCount": 1 - }, - "EmailSubject": { - "f1": 0.8181817531585693, - "precision": 0.75, - "recall": 0.8999999761581421, - "truePositiveCount": 9, - "trueNegativeCount": 0, - "falsePositiveCount": 3, - "falseNegativeCount": 1 - }, - "Message": { - "f1": 0.75, - "precision": 0.75, - "recall": 0.75, - "truePositiveCount": 6, - "trueNegativeCount": 0, - "falsePositiveCount": 2, - "falseNegativeCount": 2 - }, - "Date": { - "f1": 0.800000011920929, - "precision": 0.6666666865348816, - "recall": 1.0, - "truePositiveCount": 2, - "trueNegativeCount": 0, - "falsePositiveCount": 1, - "falseNegativeCount": 0 - }, - "OrderReference": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 17, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "SearchTexts": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Attachment": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 3, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "RelationshipName": { - "f1": 0.800000011920929, - "precision": 1.0, - "recall": 0.6666666865348816, - "truePositiveCount": 2, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 1 - }, - "Line": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 2, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Time": { - "f1": 0.0, - "precision": 0.0, - "recall": 0.0, - "truePositiveCount": 0, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 2 - }, - "FromRelationshipName": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 1, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "PositionReference": { - "f1": 0.0, - "precision": 0.0, - "recall": 0.0, - "truePositiveCount": 0, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 1 - } - }, - "microF1": 0.8923077, - "microPrecision": 0.8969072, - "microRecall": 0.8877551, - "macroF1": 0.7766601, - "macroPrecision": 0.7755879, - "macroRecall": 0.78849214 - }, - "intentsEvaluation": { - "confusionMatrix": { - "AddFlag": { - "AddFlag": { - "normalizedValue": 100.0, - "rawValue": 6.0 - } - }, - "AddMore": { - "AddMore": { - "normalizedValue": 100.0, - "rawValue": 17.0 - } - }, - "Cancel": { - "Cancel": { - "normalizedValue": 100.0, - "rawValue": 9.0 - } - }, - "CheckMessages": { - "CheckMessages": { - "normalizedValue": 100.0, - "rawValue": 9.0 - } - }, - "Confirm": { - "Confirm": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "Delete": { - "Delete": { - "normalizedValue": 100.0, - "rawValue": 5.0 - } - }, - "Forward": { - "Forward": { - "normalizedValue": 100.0, - "rawValue": 6.0 - } - }, - "None": { - "None": { - "normalizedValue": 100.0, - "rawValue": 1.0 - } - }, - "QueryLastText": { - "QueryLastText": { - "normalizedValue": 100.0, - "rawValue": 6.0 - } - }, - "ReadAloud": { - "ReadAloud": { - "normalizedValue": 100.0, - "rawValue": 16.0 - } - }, - "Reply": { - "Reply": { - "normalizedValue": 100.0, - "rawValue": 6.0 - } - }, - "SearchMessages": { - "SearchMessages": { - "normalizedValue": 100.0, - "rawValue": 9.0 - } - }, - "SendEmail": { - "SendEmail": { - "normalizedValue": 100.0, - "rawValue": 20.0 - } - }, - "ShowNext": { - "ShowNext": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "ShowPrevious": { - "ShowPrevious": { - "normalizedValue": 100.0, - "rawValue": 3.0 - } - } - }, - "intents": { - "AddMore": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 17, - "trueNegativeCount": 104, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Cancel": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 9, - "trueNegativeCount": 112, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "SendEmail": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 20, - "trueNegativeCount": 101, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "CheckMessages": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 9, - "trueNegativeCount": 112, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "AddFlag": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 6, - "trueNegativeCount": 115, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Reply": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 6, - "trueNegativeCount": 115, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "ReadAloud": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 16, - "trueNegativeCount": 105, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "QueryLastText": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 6, - "trueNegativeCount": 115, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "SearchMessages": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 9, - "trueNegativeCount": 112, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Delete": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 5, - "trueNegativeCount": 116, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Forward": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 6, - "trueNegativeCount": 115, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Confirm": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 117, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "ShowNext": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 117, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "ShowPrevious": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 3, - "trueNegativeCount": 118, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "None": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 1, - "trueNegativeCount": 120, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - } - }, - "microF1": 1.0, - "microPrecision": 1.0, - "microRecall": 1.0, - "macroF1": 1.0, - "macroPrecision": 1.0, - "macroRecall": 1.0 - }, - "evaluationOptions": { - "kind": "percentage", - "trainingSplitPercentage": 80, - "testingSplitPercentage": 20 - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json deleted file mode 100644 index 3f7176e42a78..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_GetProject", - "title": "Successful Get Project", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "myproject" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "Conversation", - "projectName": "myproject", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json deleted file mode 100644 index 1233a3b5702e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_GetProjectDeletionStatus", - "title": "Successful Get Project Deletion Status", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000", - "createdDateTime": "2022-04-18T14:02:34Z", - "lastUpdatedDateTime": "2022-04-18T14:02:34Z", - "expirationDateTime": "2022-04-25T14:02:34Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json deleted file mode 100644 index 2257c4f00e3f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json +++ /dev/null @@ -1,400 +0,0 @@ -{ - "operationId": "ConversationAuthoringListSupportedLanguages", - "title": "Successful Get Supported Languages", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectKind": "Conversation" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "languageName": "English", - "languageCode": "en" - }, - { - "languageName": "English", - "languageCode": "en-us" - }, - { - "languageName": "English (UK)", - "languageCode": "en-gb" - }, - { - "languageName": "French", - "languageCode": "fr" - }, - { - "languageName": "Italian", - "languageCode": "it" - }, - { - "languageName": "Spanish", - "languageCode": "es" - }, - { - "languageName": "German", - "languageCode": "de" - }, - { - "languageName": "Portuguese (Brazil)", - "languageCode": "pt-br" - }, - { - "languageName": "Portuguese (Portugal)", - "languageCode": "pt-pt" - }, - { - "languageName": "Chinese (Simplified)", - "languageCode": "zh-hans" - }, - { - "languageName": "Japanese", - "languageCode": "ja" - }, - { - "languageName": "Korean", - "languageCode": "ko" - }, - { - "languageName": "Dutch", - "languageCode": "nl" - }, - { - "languageName": "Hindi", - "languageCode": "hi" - }, - { - "languageName": "Turkish", - "languageCode": "tr" - }, - { - "languageName": "Gujarati", - "languageCode": "gu" - }, - { - "languageName": "Marathi", - "languageCode": "mr" - }, - { - "languageName": "Tamil", - "languageCode": "ta" - }, - { - "languageName": "Telugu", - "languageCode": "te" - }, - { - "languageName": "Zulu", - "languageCode": "zu" - }, - { - "languageName": "Afrikaans", - "languageCode": "af" - }, - { - "languageName": "Amharic", - "languageCode": "am" - }, - { - "languageName": "Arabic", - "languageCode": "ar" - }, - { - "languageName": "Assamese", - "languageCode": "as" - }, - { - "languageName": "Azerbaijani", - "languageCode": "az" - }, - { - "languageName": "Belarusian", - "languageCode": "be" - }, - { - "languageName": "Bulgarian", - "languageCode": "bg" - }, - { - "languageName": "Breton", - "languageCode": "br" - }, - { - "languageName": "Bosnian", - "languageCode": "bs" - }, - { - "languageName": "Catalan", - "languageCode": "ca" - }, - { - "languageName": "Czech", - "languageCode": "cs" - }, - { - "languageName": "Welsh", - "languageCode": "cy" - }, - { - "languageName": "Danish", - "languageCode": "da" - }, - { - "languageName": "Greek", - "languageCode": "el" - }, - { - "languageName": "Esperanto", - "languageCode": "eo" - }, - { - "languageName": "Estonian", - "languageCode": "et" - }, - { - "languageName": "Basque", - "languageCode": "eu" - }, - { - "languageName": "Persian", - "languageCode": "fa" - }, - { - "languageName": "Finnish", - "languageCode": "fi" - }, - { - "languageName": "Western Frisian", - "languageCode": "fy" - }, - { - "languageName": "Irish", - "languageCode": "ga" - }, - { - "languageName": "Scottish Gaelic", - "languageCode": "gd" - }, - { - "languageName": "Galician", - "languageCode": "gl" - }, - { - "languageName": "Hausa", - "languageCode": "ha" - }, - { - "languageName": "Hebrew", - "languageCode": "he" - }, - { - "languageName": "Croatian", - "languageCode": "hr" - }, - { - "languageName": "Hungarian", - "languageCode": "hu" - }, - { - "languageName": "Armenian", - "languageCode": "hy" - }, - { - "languageName": "Indonesian", - "languageCode": "id" - }, - { - "languageName": "Javanese", - "languageCode": "jv" - }, - { - "languageName": "Georgian", - "languageCode": "ka" - }, - { - "languageName": "Kazakh", - "languageCode": "kk" - }, - { - "languageName": "Khmer", - "languageCode": "km" - }, - { - "languageName": "Kannada", - "languageCode": "kn" - }, - { - "languageName": "Kurdish (Kurmanji)", - "languageCode": "ku" - }, - { - "languageName": "Kyrgyz", - "languageCode": "ky" - }, - { - "languageName": "Latin", - "languageCode": "la" - }, - { - "languageName": "Lao", - "languageCode": "lo" - }, - { - "languageName": "Lithuanian", - "languageCode": "lt" - }, - { - "languageName": "Latvian", - "languageCode": "lv" - }, - { - "languageName": "Malagasy", - "languageCode": "mg" - }, - { - "languageName": "Macedonian", - "languageCode": "mk" - }, - { - "languageName": "Malayalam", - "languageCode": "ml" - }, - { - "languageName": "Mongolian", - "languageCode": "mn" - }, - { - "languageName": "Malay", - "languageCode": "ms" - }, - { - "languageName": "Burmese", - "languageCode": "my" - }, - { - "languageName": "Nepali", - "languageCode": "ne" - }, - { - "languageName": "Norwegian (Bokmal)", - "languageCode": "nb" - }, - { - "languageName": "Odia", - "languageCode": "or" - }, - { - "languageName": "Punjabi", - "languageCode": "pa" - }, - { - "languageName": "Polish", - "languageCode": "pl" - }, - { - "languageName": "Pashto", - "languageCode": "ps" - }, - { - "languageName": "Romanian", - "languageCode": "ro" - }, - { - "languageName": "Russian", - "languageCode": "ru" - }, - { - "languageName": "Sanskrit", - "languageCode": "sa" - }, - { - "languageName": "Sindhi", - "languageCode": "sd" - }, - { - "languageName": "Sinhala", - "languageCode": "si" - }, - { - "languageName": "Slovak", - "languageCode": "sk" - }, - { - "languageName": "Slovenian", - "languageCode": "sl" - }, - { - "languageName": "Somali", - "languageCode": "so" - }, - { - "languageName": "Albanian", - "languageCode": "sq" - }, - { - "languageName": "Serbian", - "languageCode": "sr" - }, - { - "languageName": "Sundanese", - "languageCode": "su" - }, - { - "languageName": "Swedish", - "languageCode": "sv" - }, - { - "languageName": "Swahili", - "languageCode": "sw" - }, - { - "languageName": "Thai", - "languageCode": "th" - }, - { - "languageName": "Filipino", - "languageCode": "tl" - }, - { - "languageName": "Uyghur", - "languageCode": "ug" - }, - { - "languageName": "Ukrainian", - "languageCode": "uk" - }, - { - "languageName": "Urdu", - "languageCode": "ur" - }, - { - "languageName": "Uzbek", - "languageCode": "uz" - }, - { - "languageName": "Vietnamese", - "languageCode": "vi" - }, - { - "languageName": "Xhosa", - "languageCode": "xh" - }, - { - "languageName": "Yiddish", - "languageCode": "yi" - }, - { - "languageName": "Chinese (Traditional)", - "languageCode": "zh-hant" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json deleted file mode 100644 index eed66fd783ae..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json +++ /dev/null @@ -1,100 +0,0 @@ -{ - "operationId": "ConversationAuthoringListSupportedPrebuiltEntities", - "title": "Successful Get Supported Prebuilt Entities", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "language": "en" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "category": "Person.Name", - "description": "Name of an individual", - "examples": "john, Sam, Lisa" - }, - { - "category": "General.Event", - "description": "Important events", - "examples": "World War two, Covid 19" - }, - { - "category": "General.Organization", - "description": "Companies and corporations", - "examples": "Microsoft, Amazon" - }, - { - "category": "Choice.Boolean", - "description": "boolean choice", - "examples": "yes, no, agreed" - }, - { - "category": "Quantity.Age", - "description": "Age of a person or thing", - "examples": "10-month-old, 19 years old, 58 year-old" - }, - { - "category": "Quantity.NumberRange", - "description": "a numeric interval", - "examples": "between 25 and 35, 25-35" - }, - { - "category": "Quantity.Number", - "description": "A cardinal number in numeric or text form", - "examples": "ten, forty two, 3.141, 10K" - }, - { - "category": "Quantity.Percentage", - "description": "A percentage, using the symbol % or the word \"percent\"", - "examples": "10%, 5.6 percent" - }, - { - "category": "Quantity.Ordinal", - "description": "An ordinal number in numeric or text form", - "examples": "first, second, tenth, 1st, 2nd, 10th" - }, - { - "category": "Quantity.Dimension", - "description": "Spacial dimensions, including length, distance, area, and volume", - "examples": "2 miles, 650 square kilometres, 9,350 feet" - }, - { - "category": "Quantity.Temperature", - "description": "A temperature in celsius or fahrenheit", - "examples": "32F, 34 degrees celsius, 2 deg C" - }, - { - "category": "Quantity.Currency", - "description": "Monetary amounts, including currency", - "examples": "1000.00 US dollars, £20.00, $ 67.5 B" - }, - { - "category": "DateTime", - "description": "exact date values", - "examples": "May 11th" - }, - { - "category": "Email", - "description": "Email addresses", - "examples": "user@example.net, user_name@example.com, user.Name12@example.net" - }, - { - "category": "Phone Number", - "description": "US phone numbers", - "examples": "123-456-7890, +1 123 456 789, (123)456-789" - }, - { - "category": "URL", - "description": "Websites URLs and links", - "examples": "www.example.com, http://example.net?name=my_name&age=10" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json deleted file mode 100644 index 1e82d1c28ad0..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "ConversationAuthoringListTrainingConfigVersions", - "title": "Successful Get Supported Training Config Versions", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectKind": "Conversation" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "trainingConfigVersion": "2022-05-01", - "modelExpirationDate": "2022-10-28" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json deleted file mode 100644 index bdfff3397021..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_GetSwapDeploymentsStatus", - "title": "Successful Get Swap Deployments Status", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", - "createdDateTime": "2022-04-18T16:09:50Z", - "lastUpdatedDateTime": "2022-04-18T16:09:58Z", - "expirationDateTime": "2022-04-25T16:09:50Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json deleted file mode 100644 index 4ccaf8e7fbbd..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_GetTrainingStatus", - "title": "Successful Get Train Status", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "result": { - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "trainingMode": "standard", - "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", - "trainingStatus": { - "percentComplete": 3, - "startDateTime": "2022-04-18T15:45:06.8190649Z", - "status": "running" - }, - "evaluationStatus": { - "percentComplete": 0, - "status": "notStarted" - } - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:45:48Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "running" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json deleted file mode 100644 index 6a67af6bcc13..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_GetUnassignDeploymentResourcesStatus", - "title": "Successful Get Unassign Deployment Resources Status", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json deleted file mode 100644 index 937d9abd29f3..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json +++ /dev/null @@ -1,80 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_Import", - "title": "Successful Import Project", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "body": { - "projectFileVersion": "2022-05-01", - "stringIndexType": "Utf16CodeUnit", - "metadata": { - "projectKind": "Conversation", - "settings": { - "confidenceThreshold": 0.7 - }, - "projectName": "EmailApp", - "multilingual": true, - "description": "Trying out CLU", - "language": "en-us" - }, - "assets": { - "projectKind": "Conversation", - "intents": [ - { - "category": "Read" - }, - { - "category": "Delete" - } - ], - "entities": [ - { - "category": "Sender" - }, - { - "category": "Number", - "regex": { - "expressions": [ - { - "regexKey": "UK Phone numbers", - "language": "en-us", - "regexPattern": "/^\\(?([0-9]{3})\\)?[-.\\s]?([0-9]{3})[-.\\s]?([0-9]{4})$/" - } - ] - } - } - ], - "utterances": [ - { - "text": "Open Blake's email", - "dataset": "Train", - "intent": "Read", - "entities": [ - { - "category": "Sender", - "offset": 5, - "length": 5 - } - ] - }, - { - "text": "Delete last email", - "language": "en-gb", - "dataset": "Test", - "intent": "Delete", - "entities": [] - } - ] - } - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json deleted file mode 100644 index 998a00855f04..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "operationId": "ConversationAuthoringListAssignedResourceDeployments", - "title": "Successful List Assigned Resource Deployments", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "projectName": "Booking", - "deploymentsMetadata": [ - { - "deploymentName": "staging", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "deploymentExpirationDate": "2023-10-28" - } - ] - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json deleted file mode 100644 index a769ddf26dbc..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "operationId": "ConversationAuthoringListDeploymentResources", - "title": "Successful List Deployment Resources", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "region": "westeurope" - }, - { - "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", - "region": "eastus" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json deleted file mode 100644 index bee4a78c2572..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json +++ /dev/null @@ -1,51 +0,0 @@ -{ - "operationId": "ConversationAuthoringListDeployments", - "title": "Successful List Deployments", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "deploymentName": "production", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T16:03:51Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01", - "assignedResources": [ - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "region": "westeurope" - }, - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", - "region": "eastus" - } - ] - }, - { - "deploymentName": "staging", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T15:53:04Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01", - "assignedResources": [ - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "region": "westeurope" - } - ] - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json deleted file mode 100644 index 2eaefce284de..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "operationId": "ConversationAuthoringListTrainedModels", - "title": "Successful List Models", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "label": "model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49Z", - "lastTrainingDurationInSeconds": 186, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01", - "hasSnapshot": true - }, - { - "label": "model2", - "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", - "lastTrainedDateTime": "2022-04-18T17:25:22Z", - "lastTrainingDurationInSeconds": 192, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01", - "hasSnapshot": true - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json deleted file mode 100644 index 8bacb7c7bb6f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "operationId": "ConversationAuthoringListProjects", - "title": "Successful List Projects", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "createdDateTime": "2022-04-18T14:03:16Z", - "lastModifiedDateTime": "2022-04-18T14:03:16Z", - "projectKind": "Conversation", - "projectName": "myproject1", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - }, - { - "createdDateTime": "2022-04-18T14:03:12Z", - "lastModifiedDateTime": "2022-04-18T14:03:12Z", - "projectKind": "Conversation", - "projectName": "myproject", - "multilingual": false, - "description": "This is a sample conversation project.", - "language": "en" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json deleted file mode 100644 index f077fb02c908..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json +++ /dev/null @@ -1,92 +0,0 @@ -{ - "operationId": "ConversationAuthoringListTrainingJobs", - "title": "Successful List Training Jobs", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "result": { - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "trainingMode": "advanced", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T15:45:06.8190649Z", - "endDateTime": "2022-04-18T15:47:19.2639682Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T15:47:19.2734976Z", - "endDateTime": "2022-04-18T15:47:23.8378892Z", - "status": "succeeded" - } - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:47:50Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "succeeded" - }, - { - "result": { - "modelLabel": "model2", - "trainingConfigVersion": "2022-05-01", - "trainingMode": "standard", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:22:39.3663023Z", - "endDateTime": "2022-04-18T17:24:51.9440947Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:24:51.9571747Z", - "endDateTime": "2022-04-18T17:24:58.1427823Z", - "status": "succeeded" - } - }, - "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", - "createdDateTime": "2022-04-18T17:22:11Z", - "lastUpdatedDateTime": "2022-04-18T17:25:23Z", - "expirationDateTime": "2022-04-25T17:22:11Z", - "status": "succeeded" - }, - { - "result": { - "modelLabel": "model2", - "trainingConfigVersion": "2022-05-01", - "trainingMode": "standard", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:44:41.388358Z", - "endDateTime": "2022-04-18T17:50:29.5675101Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:50:29.5808461Z", - "endDateTime": "2022-04-18T17:50:35.3482185Z", - "status": "succeeded" - } - }, - "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", - "createdDateTime": "2022-04-18T17:44:04Z", - "lastUpdatedDateTime": "2022-04-18T17:51:11Z", - "expirationDateTime": "2022-04-25T17:44:04Z", - "status": "succeeded" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json deleted file mode 100644 index 797017261207..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "ConversationAuthoringTrainedModel_LoadSnapshot", - "title": "Successful Load Snapshot", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "trainedModelLabel": "model1" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/load-snapshot/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json deleted file mode 100644 index 9535d1fcdc75..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_SwapDeployments", - "title": "Successful Swap Deployments", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "body": { - "firstDeploymentName": "production", - "secondDeploymentName": "staging" - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json deleted file mode 100644 index 8e109bcaca7b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_Train", - "title": "Successful Train Project", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "body": { - "modelLabel": "model1", - "trainingMode": "standard", - "trainingConfigVersion": "latest", - "evaluationOptions": { - "kind": "percentage", - "testingSplitPercentage": 20, - "trainingSplitPercentage": 80 - } - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json deleted file mode 100644 index 97ab3ade136a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "ConversationAuthoringProject_UnassignDeploymentResources", - "title": "Successful Unassign Deployment Resources", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "EmailApp", - "deploymentName": "production", - "body": { - "assignedResourceIds": [ - "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" - ] - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/resources/unassign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulAssignDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulAssignDeploymentResources.json deleted file mode 100644 index f2b7ac433ff9..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulAssignDeploymentResources.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "operationId": "TextAuthoringProject_AssignDeploymentResources", - "title": "Successful Assign Deployment Resources", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "body": { - "resourcesMetadata": [ - { - "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "customDomain": "lang-test-weu.cognitiveservices.azure.com", - "region": "westeurope" - }, - { - "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", - "customDomain": "lang-test-eus.cognitiveservices.azure.com", - "region": "eastus" - } - ] - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/resources/assign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json deleted file mode 100644 index 5f2a722afbe9..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "TextAuthoringProject_CancelTrainingJob", - "title": "Successful Cancel Training Job", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulCopyProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulCopyProject.json deleted file mode 100644 index 2927f17ff030..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulCopyProject.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "operationId": "TextAuthoringProject_CopyProject", - "title": "SuccessfulCopyProject", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "body": { - "projectKind": "CustomEntityRecognition", - "targetProjectName": "LoanAgreements", - "accessToken": "c0b13e0c-e9fe-4afa-aa11-db3b9b28f5e2", - "expiresAt": "2022-04-18T13:53:03Z", - "targetResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "targetResourceRegion": "westeurope" - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/copy/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulCopyProjectAuthorization.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulCopyProjectAuthorization.json deleted file mode 100644 index b521ec71585b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulCopyProjectAuthorization.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "operationId": "TextAuthoringProject_CopyProjectAuthorization", - "title": "SuccessfulCopyProjectAuthorization", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "body": { - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "allowOverwrite": false - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "projectKind": "CustomEntityRecognition", - "targetProjectName": "LoanAgreements", - "accessToken": "c0b13e0c-e9fe-4afa-aa11-db3b9b28f5e2", - "expiresAt": "2022-04-18T13:53:03Z", - "targetResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "targetResourceRegion": "westeurope" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulCreateExportedModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulCreateExportedModel.json deleted file mode 100644 index a984d1854edf..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulCreateExportedModel.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "operationId": "TextAuthoringExportedModel_CreateOrUpdateExportedModel", - "title": "SuccessfulCreateExportedModel", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "exportedModelName": "exported-model1", - "body": { - "trainedModelLabel": "model1" - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/exported-models/exported-model1/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulCreateProject.json deleted file mode 100644 index 0b4ab252c30c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulCreateProject.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "operationId": "TextAuthoringProject_CreateProject", - "title": "SuccessfulCreateProject", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/merge-patch+json", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "body": { - "projectName": "LoanAgreements", - "language": "en", - "projectKind": "CustomEntityRecognition", - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "multilingual": false, - "storageInputContainerName": "loanagreements" - } - }, - "responses": { - "201": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - } - }, - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json deleted file mode 100644 index d199822d3522..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "TextAuthoringDeployment_DeleteDeployment", - "title": "SuccessfulDeleteDeployment", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "deploymentName": "staging" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/staging/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeleteDeploymentFromResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeleteDeploymentFromResources.json deleted file mode 100644 index 8389dcdeb611..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeleteDeploymentFromResources.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "TextAuthoringDeployment_DeleteDeploymentFromResources", - "title": "SuccessfulDeleteDeploymentFromResources", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "deploymentName": "staging", - "body": { - "assignedResourceIds": [ - "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" - ] - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/deployments/staging/delete-from-resources/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeleteExportedModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeleteExportedModel.json deleted file mode 100644 index c600a7f2b7d5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeleteExportedModel.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "TextAuthoringExportedModel_DeleteExportedModel", - "title": "SuccessfulDeleteExportedModel", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "exportedModelName": "exported-model1" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/exported-models/exported-model1/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeleteModel.json deleted file mode 100644 index b6a9a3bf070a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeleteModel.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "TextAuthoringTrainedModel_DeleteTrainedModel", - "title": "SuccessfulDeleteModel", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model2" - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeleteProject.json deleted file mode 100644 index c7a3f9f5b4f8..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeleteProject.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "TextAuthoringProject_DeleteProject", - "title": "SuccessfulDeleteProject", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeployProject.json deleted file mode 100644 index d3c6153de44a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulDeployProject.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "operationId": "TextAuthoringDeployment_DeployProject", - "title": "SuccessfulDeployProject", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "deploymentName": "production", - "body": { - "trainedModelLabel": "29886710a2ae49259d62cffca977db66", - "assignedResourceIds": [ - "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus" - ] - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulEvaluationProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulEvaluationProject.json deleted file mode 100644 index 128ef068776d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulEvaluationProject.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "TextAuthoringTrainedModel_EvaluateModel", - "title": "SuccessfulEvaluationProject", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model1", - "body": { - "kind": "percentage", - "testingSplitPercentage": 20, - "trainingSplitPercentage": 80 - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/models/model1/evaluate/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulExportProject.json deleted file mode 100644 index ebaf04d2b440..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulExportProject.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "TextAuthoringProject_Export", - "title": "SuccessfulExportProject", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "stringIndexType": "Utf16CodeUnit" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json deleted file mode 100644 index 8cf1ddcb1bce..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "TextAuthoringProject_GetAssignDeploymentResourcesStatus", - "title": "SuccessfulGetAssignDeploymentResourcesStatus", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetCopyProjectStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetCopyProjectStatus.json deleted file mode 100644 index 784d15333027..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetCopyProjectStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "TextAuthoringProject_GetCopyProjectStatus", - "title": "SuccessfulGetCopyProjectStatus", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetDeployment.json deleted file mode 100644 index 56409dcd193f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetDeployment.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "operationId": "TextAuthoringDeployment_GetDeployment", - "title": "SuccessfulGetDeployment", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "deploymentName": "staging" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "deploymentName": "staging", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T15:53:04Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-15-preview", - "assignedResources": [ - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "region": "westeurope" - }, - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", - "region": "eastus" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json deleted file mode 100644 index 88d9c3ce8860..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "TextAuthoringDeployment_GetDeploymentDeleteFromResourcesStatus", - "title": "SuccessfulGetDeploymentDeleteFromResourcesStatus", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "deploymentName": "production", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json deleted file mode 100644 index 08a7f364f0ba..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "TextAuthoringDeployment_GetDeploymentStatus", - "title": "SuccessfulGetDeploymentStatus", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "deploymentName": "production", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetEvaluationStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetEvaluationStatus.json deleted file mode 100644 index 88609d667071..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetEvaluationStatus.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "operationId": "TextAuthoringTrainedModel_GetEvaluationStatus", - "title": "SuccessfulGetEvaluationStatus", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model1", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "result": { - "evaluationOptions": { - "kind": "percentage", - "trainingSplitPercentage": 60, - "testingSplitPercentage": 40 - }, - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "percentComplete": 30 - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:45:48Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "running" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetExportStatus.json deleted file mode 100644 index efa08386726b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetExportStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "TextAuthoringProject_GetExportStatus", - "title": "SuccessfulGetExportStatus", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "resultUrl": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2023-04-15-preview", - "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", - "createdDateTime": "2022-04-18T15:23:07Z", - "lastUpdatedDateTime": "2022-04-18T15:23:08Z", - "expirationDateTime": "2022-04-25T15:23:07Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModel.json deleted file mode 100644 index fc8f5ae0d757..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModel.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "TextAuthoringExportedModel_GetExportedModel", - "title": "SuccessfulGetExportedModel", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "exportedModelName": "exported-model1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "exportedModelName": "exported-model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2023-04-18T15:47:49Z", - "lastExportedModelDateTime": "2023-04-18T16:03:51Z", - "modelExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModelManifest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModelManifest.json deleted file mode 100644 index 454ee82d7bad..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModelManifest.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "operationId": "TextAuthoringExportedModel_GetExportedModelManifest", - "title": "SuccessfulGetExportedModelManifest", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "exportedModelName": "exported-model1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "modelFiles": [ - { - "name": "customModelFile", - "contentUri": "https://dummy.blob.core.windows.net/custommodel" - }, - { - "name": "customModelFile1", - "contentUri": "https://aicpstaticfilesdev.blob.core.windows.net/custommodel1" - }, - { - "name": "BaseModelfile1", - "contentUri": "https://aicpstaticfilesdev.blob.core.windows.net/basemodel1" - }, - { - "name": "customModelFile2", - "contentUri": "https://aicpstaticfilesdev.blob.core.windows.net/custommodel2" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModelStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModelStatus.json deleted file mode 100644 index 6a87a6f3b7b1..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModelStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "TextAuthoringExportedModel_GetExportedModelJobStatus", - "title": "SuccessfulGetExportedModelStatus", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "exportedModelName": "exported-model1", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2023-04-18T15:44:44Z", - "lastUpdatedDateTime": "2023-04-18T15:45:48Z", - "expirationDateTime": "2023-04-25T15:44:44Z", - "status": "running" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetImportStatus.json deleted file mode 100644 index 29f50db1e3fb..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetImportStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "TextAuthoringProject_GetImportStatus", - "title": "SuccessfulGetImportStatus", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", - "createdDateTime": "2022-04-18T15:17:20Z", - "lastUpdatedDateTime": "2022-04-18T15:17:22Z", - "expirationDateTime": "2022-04-25T15:17:20Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetLoadSnapshotStatus.json deleted file mode 100644 index 944d999ef8fb..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetLoadSnapshotStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "TextAuthoringTrainedModel_GetLoadSnapshotStatus", - "title": "SuccessfulGetLoadSnapshotStatus", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model1", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:45:48Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "running" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetModel.json deleted file mode 100644 index 17a80aac17c0..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetModel.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "operationId": "TextAuthoringTrainedModel_GetTrainedModel", - "title": "SuccessfulGetModel", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "label": "model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49Z", - "lastTrainingDurationInSeconds": 186, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-15-preview", - "hasSnapshot": true - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json deleted file mode 100644 index bffbabee4d8b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json +++ /dev/null @@ -1,297 +0,0 @@ -{ - "operationId": "TextAuthoringTrainedModel_GetModelEvaluationResults", - "title": "SuccessfulGetModelEvaluation", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model2", - "stringIndexType": "Utf16CodeUnit", - "maxpagesize": 10 - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "location": "11.txt", - "language": "en-us", - "projectKind": "CustomEntityRecognition", - "customEntityRecognitionResult": { - "entities": [ - { - "expectedEntities": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "BorrowerName", - "offset": 160, - "length": 13 - }, - { - "category": "BorrowerAddress", - "offset": 181, - "length": 34 - }, - { - "category": "BorrowerCity", - "offset": 225, - "length": 6 - }, - { - "category": "BorrowerState", - "offset": 242, - "length": 8 - }, - { - "category": "LenderName", - "offset": 271, - "length": 12 - }, - { - "category": "LenderAddress", - "offset": 310, - "length": 20 - }, - { - "category": "LenderCity", - "offset": 340, - "length": 8 - }, - { - "category": "LenderState", - "offset": 359, - "length": 11 - }, - { - "category": "LoanAmountWords", - "offset": 448, - "length": 52 - }, - { - "category": "LoanAmountNumbers", - "offset": 502, - "length": 10 - }, - { - "category": "Interest", - "offset": 588, - "length": 2 - } - ], - "predictedEntities": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "BorrowerName", - "offset": 160, - "length": 13 - }, - { - "category": "BorrowerAddress", - "offset": 200, - "length": 15 - }, - { - "category": "BorrowerCity", - "offset": 225, - "length": 6 - }, - { - "category": "BorrowerState", - "offset": 242, - "length": 8 - }, - { - "category": "LenderName", - "offset": 271, - "length": 12 - }, - { - "category": "LenderAddress", - "offset": 310, - "length": 20 - }, - { - "category": "LenderCity", - "offset": 340, - "length": 8 - }, - { - "category": "LenderState", - "offset": 359, - "length": 11 - }, - { - "category": "LoanAmountWords", - "offset": 448, - "length": 52 - }, - { - "category": "LoanAmountNumbers", - "offset": 502, - "length": 10 - }, - { - "category": "Interest", - "offset": 588, - "length": 2 - } - ], - "regionOffset": 0, - "regionLength": 1780 - } - ] - } - }, - { - "location": "01.txt", - "language": "en-us", - "projectKind": "CustomEntityRecognition", - "customEntityRecognitionResult": { - "entities": [ - { - "expectedEntities": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "BorrowerName", - "offset": 160, - "length": 13 - }, - { - "category": "BorrowerAddress", - "offset": 200, - "length": 13 - }, - { - "category": "BorrowerCity", - "offset": 223, - "length": 9 - }, - { - "category": "BorrowerState", - "offset": 243, - "length": 8 - }, - { - "category": "LenderName", - "offset": 273, - "length": 14 - }, - { - "category": "LenderAddress", - "offset": 314, - "length": 15 - }, - { - "category": "LenderCity", - "offset": 339, - "length": 10 - }, - { - "category": "LenderState", - "offset": 360, - "length": 8 - }, - { - "category": "LoanAmountWords", - "offset": 446, - "length": 66 - }, - { - "category": "LoanAmountNumbers", - "offset": 514, - "length": 11 - }, - { - "category": "Interest", - "offset": 601, - "length": 2 - } - ], - "predictedEntities": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "BorrowerName", - "offset": 160, - "length": 13 - }, - { - "category": "BorrowerAddress", - "offset": 200, - "length": 13 - }, - { - "category": "BorrowerCity", - "offset": 223, - "length": 9 - }, - { - "category": "BorrowerState", - "offset": 243, - "length": 8 - }, - { - "category": "LenderName", - "offset": 273, - "length": 14 - }, - { - "category": "LenderAddress", - "offset": 314, - "length": 15 - }, - { - "category": "LenderCity", - "offset": 339, - "length": 10 - }, - { - "category": "LenderState", - "offset": 360, - "length": 8 - }, - { - "category": "LoanAmountWords", - "offset": 446, - "length": 66 - }, - { - "category": "LoanAmountNumbers", - "offset": 514, - "length": 11 - }, - { - "category": "Interest", - "offset": 601, - "length": 2 - } - ], - "regionOffset": 0, - "regionLength": 1793 - } - ] - } - } - ], - "nextLink": "https://api.example.com/language/authoring/analyze-text/projects/LoanAgreements/models/model2/evaluation/result/?api-version=2023-04-15-preview&top=2147483645&skip=100&maxpagesize=100" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json deleted file mode 100644 index 3f45aa1becc5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json +++ /dev/null @@ -1,234 +0,0 @@ -{ - "operationId": "TextAuthoringTrainedModel_GetModelEvaluationSummary", - "title": "SuccessfulGetModelEvaluationSummary", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model2" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "projectKind": "CustomEntityRecognition", - "customEntityRecognitionEvaluation": { - "confusionMatrix": { - "BorrowerAddress": { - "BorrowerAddress": { - "normalizedValue": 86.206894, - "rawValue": 3.4482758 - }, - "$none": { - "normalizedValue": 13.793103, - "rawValue": 0.55172414 - } - }, - "BorrowerCity": { - "BorrowerCity": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "BorrowerName": { - "BorrowerName": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "BorrowerState": { - "BorrowerState": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "Date": { - "Date": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "Interest": { - "Interest": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LenderAddress": { - "LenderAddress": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LenderCity": { - "LenderCity": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LenderName": { - "LenderName": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LenderState": { - "LenderState": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LoanAmountNumbers": { - "LoanAmountNumbers": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "LoanAmountWords": { - "LoanAmountWords": { - "normalizedValue": 100.0, - "rawValue": 4.0 - } - }, - "$none": { - "$none": { - "normalizedValue": 99.81485, - "rawValue": 51.90372 - }, - "BorrowerAddress": { - "normalizedValue": 0.18315019, - "rawValue": 0.0952381 - }, - "Interest": { - "normalizedValue": 0.002005294, - "rawValue": 0.0010427529 - } - } - }, - "entities": { - "Date": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "BorrowerName": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "BorrowerAddress": { - "f1": 0.6666666865348816, - "precision": 0.6000000238418579, - "recall": 0.75, - "truePositiveCount": 3, - "trueNegativeCount": 0, - "falsePositiveCount": 2, - "falseNegativeCount": 1 - }, - "BorrowerCity": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "BorrowerState": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LenderName": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LenderAddress": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LenderCity": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LenderState": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LoanAmountWords": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "LoanAmountNumbers": { - "f1": 1.0, - "precision": 1.0, - "recall": 1.0, - "truePositiveCount": 4, - "trueNegativeCount": 0, - "falsePositiveCount": 0, - "falseNegativeCount": 0 - }, - "Interest": { - "f1": 0.75, - "precision": 0.75, - "recall": 0.75, - "truePositiveCount": 3, - "trueNegativeCount": 0, - "falsePositiveCount": 1, - "falseNegativeCount": 1 - } - }, - "microF1": 0.94845366, - "microPrecision": 0.93877554, - "microRecall": 0.9583333, - "macroF1": 0.9513889, - "macroPrecision": 0.9458334, - "macroRecall": 0.9583333 - }, - "evaluationOptions": { - "kind": "percentage", - "trainingSplitPercentage": 80, - "testingSplitPercentage": 20 - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetProject.json deleted file mode 100644 index ef975ebff9e3..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetProject.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "operationId": "TextAuthoringProject_GetProject", - "title": "SuccessfulGetProject", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json deleted file mode 100644 index df9fdba78a74..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "operationId": "TextAuthoringProject_GetProjectDeletionStatus", - "title": "SuccessfulGetProjectDeletionStatus", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000", - "createdDateTime": "2022-04-18T14:02:34Z", - "lastUpdatedDateTime": "2022-04-18T14:02:34Z", - "expirationDateTime": "2022-04-25T14:02:34Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json deleted file mode 100644 index 86124b29d76c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json +++ /dev/null @@ -1,391 +0,0 @@ -{ - "operationId": "TextAnalysisAuthoringGetSupportedLanguages", - "title": "SuccessfulGetSupportedLanguages", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "languageName": "English", - "languageCode": "en" - }, - { - "languageName": "English", - "languageCode": "en-us" - }, - { - "languageName": "French", - "languageCode": "fr" - }, - { - "languageName": "Italian", - "languageCode": "it" - }, - { - "languageName": "Spanish", - "languageCode": "es" - }, - { - "languageName": "German", - "languageCode": "de" - }, - { - "languageName": "Portuguese (Brazil)", - "languageCode": "pt-br" - }, - { - "languageName": "Portuguese (Portugal)", - "languageCode": "pt-pt" - }, - { - "languageName": "Afrikaans", - "languageCode": "af" - }, - { - "languageName": "Amharic", - "languageCode": "am" - }, - { - "languageName": "Arabic", - "languageCode": "ar" - }, - { - "languageName": "Assamese", - "languageCode": "as" - }, - { - "languageName": "Azerbaijani", - "languageCode": "az" - }, - { - "languageName": "Belarusian", - "languageCode": "be" - }, - { - "languageName": "Bulgarian", - "languageCode": "bg" - }, - { - "languageName": "Breton", - "languageCode": "br" - }, - { - "languageName": "Bosnian", - "languageCode": "bs" - }, - { - "languageName": "Catalan", - "languageCode": "ca" - }, - { - "languageName": "Czech", - "languageCode": "cs" - }, - { - "languageName": "Welsh", - "languageCode": "cy" - }, - { - "languageName": "Danish", - "languageCode": "da" - }, - { - "languageName": "Greek", - "languageCode": "el" - }, - { - "languageName": "Esperanto", - "languageCode": "eo" - }, - { - "languageName": "Estonian", - "languageCode": "et" - }, - { - "languageName": "Basque", - "languageCode": "eu" - }, - { - "languageName": "Persian", - "languageCode": "fa" - }, - { - "languageName": "Finnish", - "languageCode": "fi" - }, - { - "languageName": "Western Frisian", - "languageCode": "fy" - }, - { - "languageName": "Irish", - "languageCode": "ga" - }, - { - "languageName": "Scottish Gaelic", - "languageCode": "gd" - }, - { - "languageName": "Galician", - "languageCode": "gl" - }, - { - "languageName": "Gujarati", - "languageCode": "gu" - }, - { - "languageName": "Hausa", - "languageCode": "ha" - }, - { - "languageName": "Hebrew", - "languageCode": "he" - }, - { - "languageName": "Hindi", - "languageCode": "hi" - }, - { - "languageName": "Croatian", - "languageCode": "hr" - }, - { - "languageName": "Hungarian", - "languageCode": "hu" - }, - { - "languageName": "Armenian", - "languageCode": "hy" - }, - { - "languageName": "Indonesian", - "languageCode": "id" - }, - { - "languageName": "Japanese", - "languageCode": "ja" - }, - { - "languageName": "Javanese", - "languageCode": "jv" - }, - { - "languageName": "Georgian", - "languageCode": "ka" - }, - { - "languageName": "Kazakh", - "languageCode": "kk" - }, - { - "languageName": "Khmer", - "languageCode": "km" - }, - { - "languageName": "Kannada", - "languageCode": "kn" - }, - { - "languageName": "Korean", - "languageCode": "ko" - }, - { - "languageName": "Kurdish (Kurmanji)", - "languageCode": "ku" - }, - { - "languageName": "Kyrgyz", - "languageCode": "ky" - }, - { - "languageName": "Latin", - "languageCode": "la" - }, - { - "languageName": "Lao", - "languageCode": "lo" - }, - { - "languageName": "Lithuanian", - "languageCode": "lt" - }, - { - "languageName": "Latvian", - "languageCode": "lv" - }, - { - "languageName": "Malagasy", - "languageCode": "mg" - }, - { - "languageName": "Macedonian", - "languageCode": "mk" - }, - { - "languageName": "Malayalam", - "languageCode": "ml" - }, - { - "languageName": "Mongolian", - "languageCode": "mn" - }, - { - "languageName": "Marathi", - "languageCode": "mr" - }, - { - "languageName": "Malay", - "languageCode": "ms" - }, - { - "languageName": "Burmese", - "languageCode": "my" - }, - { - "languageName": "Nepali", - "languageCode": "ne" - }, - { - "languageName": "Dutch", - "languageCode": "nl" - }, - { - "languageName": "Norwegian (Bokmal)", - "languageCode": "nb" - }, - { - "languageName": "Odia", - "languageCode": "or" - }, - { - "languageName": "Punjabi", - "languageCode": "pa" - }, - { - "languageName": "Polish", - "languageCode": "pl" - }, - { - "languageName": "Pashto", - "languageCode": "ps" - }, - { - "languageName": "Romanian", - "languageCode": "ro" - }, - { - "languageName": "Russian", - "languageCode": "ru" - }, - { - "languageName": "Sanskrit", - "languageCode": "sa" - }, - { - "languageName": "Sindhi", - "languageCode": "sd" - }, - { - "languageName": "Sinhala", - "languageCode": "si" - }, - { - "languageName": "Slovak", - "languageCode": "sk" - }, - { - "languageName": "Slovenian", - "languageCode": "sl" - }, - { - "languageName": "Somali", - "languageCode": "so" - }, - { - "languageName": "Albanian", - "languageCode": "sq" - }, - { - "languageName": "Serbian", - "languageCode": "sr" - }, - { - "languageName": "Sundanese", - "languageCode": "su" - }, - { - "languageName": "Swedish", - "languageCode": "sv" - }, - { - "languageName": "Swahili", - "languageCode": "sw" - }, - { - "languageName": "Tamil", - "languageCode": "ta" - }, - { - "languageName": "Telugu", - "languageCode": "te" - }, - { - "languageName": "Thai", - "languageCode": "th" - }, - { - "languageName": "Filipino", - "languageCode": "tl" - }, - { - "languageName": "Turkish", - "languageCode": "tr" - }, - { - "languageName": "Uyghur", - "languageCode": "ug" - }, - { - "languageName": "Ukrainian", - "languageCode": "uk" - }, - { - "languageName": "Urdu", - "languageCode": "ur" - }, - { - "languageName": "Uzbek", - "languageCode": "uz" - }, - { - "languageName": "Vietnamese", - "languageCode": "vi" - }, - { - "languageName": "Xhosa", - "languageCode": "xh" - }, - { - "languageName": "Yiddish", - "languageCode": "yi" - }, - { - "languageName": "Chinese (Simplified)", - "languageCode": "zh-hans" - }, - { - "languageName": "Chinese (Traditional)", - "languageCode": "zh-hant" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedPrebuiltEntities.json deleted file mode 100644 index dddcc82420c1..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedPrebuiltEntities.json +++ /dev/null @@ -1,200 +0,0 @@ -{ - "operationId": "TextAnalysisAuthoringGetSupportedPrebuiltEntities", - "title": "SuccessfulGetSupportedPrebuiltEntities", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "language": "en" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "category": "BodyStructure", - "description": "Body systems, anatomic locations or regions, and body sites", - "examples": "arm, knee, abdomen, nose, liver, head, respiratory system, lymphocytes" - }, - { - "category": "Age", - "description": "All age terms and phrases, including ones for patients, family members, and others", - "examples": "40-year-old, 51 yo, 3 months old, adult, infant, elderly, young, minor, middle-aged" - }, - { - "category": "Gender", - "description": "Terms that disclose the gender of the subject", - "examples": "male, female, woman, gentleman, lady" - }, - { - "category": "Ethnicity", - "description": "Phrases that indicate the ethnicity of the subject", - "examples": "African American, Asian" - }, - { - "category": "ExaminationName", - "description": "Diagnostic procedures and tests, including vital signs and body measurements", - "examples": "MRI, ECG, HIV test, hemoglobin, platelets count, scale systems such as Bristol stool scale" - }, - { - "category": "Date", - "description": "Full date relating to a medical condition, examination, treatment, medication, or administrative event", - "examples": "May 11th" - }, - { - "category": "Direction", - "description": "Directional terms that may relate to a body structure, medical condition, examination, or treatment", - "examples": "left, lateral, upper, posterior" - }, - { - "category": "Frequency", - "description": "how often a medical condition, examination, treatment, or medication occurred, occurs, or should occur", - "examples": "usually" - }, - { - "category": "MeasurementValue", - "description": "The value related to an examination or a medical condition measurement", - "examples": "1, 18" - }, - { - "category": "MeasurementUnit", - "description": "The unit of measurement related to an examination or a medical condition measurement", - "examples": "cm" - }, - { - "category": "RelationalOperator", - "description": "Phrases that express the quantitative relation between an entity and some additional information", - "examples": ">, <=" - }, - { - "category": "Time", - "description": "Temporal terms relating to the beginning and/or length (duration) of a medical condition, examination, treatment, medication, or administrative event", - "examples": "10/92" - }, - { - "category": "Course", - "description": "Description of a change in another entity over time, such as condition progression / a course of treatment or medication", - "examples": "improvement, worsening, resolution, remission, increase in medication dosage" - }, - { - "category": "GeneOrProtein", - "description": "All mentions of names and symbols of human genes as well as chromosomes and parts of chromosomes and proteins", - "examples": "MTRR, F2" - }, - { - "category": "Variant", - "description": "All mentions of gene variations and mutations", - "examples": "c.524C>T, (MTRR):r.1462_1557del96" - }, - { - "category": "Expression", - "description": "Gene expression level", - "examples": "positive for-, negative for-, overexpressed, detected in high/low levels, elevated" - }, - { - "category": "MutationType", - "description": "MTRR, F2", - "examples": "trisomy, germline mutation, loss of function" - }, - { - "category": "AdministrativeEvent", - "description": "Events that relate to the healthcare system but of an administrative/semi-administrative nature", - "examples": "registration, admission, trial, study entry, transfer, discharge, hospitalization, hospital stay" - }, - { - "category": "CareEnvironment", - "description": "registration, admission, trial, study entry, transfer, discharge, hospitalization, hospital stay", - "examples": "emergency room, physician’s office, cardio unit, hospice, hospital" - }, - { - "category": "HealthcareProfession", - "description": "emergency room, physician’s office, cardio unit, hospice, hospital", - "examples": "dentist, pathologist, neurologist, radiologist, pharmacist, nutritionist, physical therapist, chiropractor" - }, - { - "category": "Diagnosis", - "description": "Disease, syndrome, poisoning", - "examples": "breast cancer, Alzheimer’s, HTN, CHF, spinal cord injury" - }, - { - "category": "SymptomOrSign", - "description": "Subjective or objective evidence of disease or other diagnoses", - "examples": "chest pain, headache, dizziness, rash, SOB, abdomen was soft, good bowel sounds, well nourished" - }, - { - "category": "ConditionQualifier", - "description": "Qualitative terms that are used to describe a medical condition", - "examples": "sudden, acute, chronic, longstanding, burning, sharp, severe, mild, a bit, uncontrolled, local, focal, diffuse" - }, - { - "category": "ConditionScale", - "description": "Qualitative terms that characterize the condition by a scale, which is a finite ordered list of values", - "examples": "stage III" - }, - { - "category": "MedicationClass", - "description": "A set of medications that have a similar mechanism of action, a related mode of action, a similar chemical structure, and/or are used to treat the same disease", - "examples": "ACE inhibitor, opioid, antibiotics, pain relievers" - }, - { - "category": "MedicationName", - "description": "Medication mentions, including copyrighted brand names, and non-brand names", - "examples": "Ibuprofen" - }, - { - "category": "Dosage", - "description": "Amount of medication ordered", - "examples": "Infuse Sodium Chloride solution 1000 mL" - }, - { - "category": "MedicationForm", - "description": "The form of the medication", - "examples": "solution, pill, capsule, tablet, patch, gel, paste, foam, spray, drops, cream, syrup" - }, - { - "category": "MedicationRoute", - "description": "The administration method of medication", - "examples": "oral, topical, inhaled" - }, - { - "category": "FamilyRelation", - "description": "Mentions of family relatives of the subject", - "examples": "father, daughter, siblings, parents" - }, - { - "category": "TreatmentName", - "description": "Therapeutic procedures", - "examples": "knee replacement surgery, bone marrow transplant, TAVI, diet" - }, - { - "category": "Allergen", - "description": "an antigen triggering an allergic reaction", - "examples": "cats, peanuts" - }, - { - "category": "Employment", - "description": "Mentions of employment status including specific profession", - "examples": "unemployed, retired, firefighter, student" - }, - { - "category": "LivingStatus", - "description": "Mentions of the housing situation", - "examples": "homeless, living with parents, living alone, living with others" - }, - { - "category": "SubstanceUse", - "description": "Mentions of use of legal or illegal drugs, tobacco or alcohol", - "examples": "smoking, drinking, or heroin" - }, - { - "category": "SubstanceUseAmount", - "description": "Mentions of specific amounts of substance use", - "examples": "a pack (of cigarettes) or a few glasses (of wine)" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json deleted file mode 100644 index 627ff19c2660..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "TextAnalysisAuthoringListTrainingConfigVersions", - "title": "SuccessfulGetSupportedTrainingConfigVersions", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectKind": "CustomEntityRecognition" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "trainingConfigVersion": "2022-05-01", - "modelExpirationDate": "2022-10-28" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json deleted file mode 100644 index a744442827f3..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "TextAuthoringProject_GetSwapDeploymentsStatus", - "title": "SuccessfulGetSwapDeploymentsStatus", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", - "createdDateTime": "2022-04-18T16:09:50Z", - "lastUpdatedDateTime": "2022-04-18T16:09:58Z", - "expirationDateTime": "2022-04-25T16:09:50Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json deleted file mode 100644 index a2eb9a4edffa..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "operationId": "TextAuthoringProject_GetTrainingStatus", - "title": "SuccessfulGetTrainStatus", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "result": { - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", - "trainingStatus": { - "percentComplete": 3, - "startDateTime": "2022-04-18T15:45:06.8190649Z", - "status": "running" - }, - "evaluationStatus": { - "percentComplete": 0, - "status": "notStarted" - } - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:45:48Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "running" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json deleted file mode 100644 index 052ed4baf3af..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "TextAuthoringProject_GetUnassignDeploymentResourcesStatus", - "title": "SuccessfulGetUnassignDeploymentResourcesStatus", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", - "createdDateTime": "2022-04-18T15:52:48Z", - "lastUpdatedDateTime": "2022-04-18T15:53:04Z", - "expirationDateTime": "2022-04-25T15:52:48Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulImportProject.json deleted file mode 100644 index 681942b5bf8b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulImportProject.json +++ /dev/null @@ -1,101 +0,0 @@ -{ - "operationId": "TextAuthoringProject_Import", - "title": "SuccessfulImportProject", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "body": { - "projectFileVersion": "2022-05-01", - "stringIndexType": "Utf16CodeUnit", - "metadata": { - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "settings": {}, - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - }, - "assets": { - "projectKind": "CustomEntityRecognition", - "entities": [ - { - "category": "Date" - }, - { - "category": "LenderName" - }, - { - "category": "LenderAddress" - } - ], - "documents": [ - { - "location": "01.txt", - "language": "en-us", - "entities": [ - { - "regionOffset": 0, - "regionLength": 1793, - "labels": [ - { - "category": "Date", - "offset": 5, - "length": 9 - }, - { - "category": "LenderName", - "offset": 273, - "length": 14 - }, - { - "category": "LenderAddress", - "offset": 314, - "length": 15 - } - ] - } - ] - }, - { - "location": "02.txt", - "language": "en-us", - "entities": [ - { - "regionOffset": 0, - "regionLength": 1804, - "labels": [ - { - "category": "Date", - "offset": 5, - "length": 10 - }, - { - "category": "LenderName", - "offset": 284, - "length": 10 - }, - { - "category": "LenderAddress", - "offset": 321, - "length": 20 - } - ] - } - ] - } - ] - } - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListAssignedResourceDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListAssignedResourceDeployments.json deleted file mode 100644 index 7ecdd6c97282..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListAssignedResourceDeployments.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "operationId": "TextAnalysisAuthoringListAssignedResourceDeployments", - "title": "SuccessfulListAssignedResourceDeployments", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "projectName": "Booking", - "deploymentsMetadata": [ - { - "deploymentName": "staging", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "deploymentExpirationDate": "2023-10-28" - } - ] - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListDeploymentResources.json deleted file mode 100644 index 81e783c77fbf..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListDeploymentResources.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "operationId": "TextAnalysisAuthoringListDeploymentResources", - "title": "SuccessfulListDeploymentResources", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "region": "westeurope" - }, - { - "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", - "region": "eastus" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListDeployments.json deleted file mode 100644 index e6e2b6e5bef8..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListDeployments.json +++ /dev/null @@ -1,51 +0,0 @@ -{ - "operationId": "TextAnalysisAuthoringListDeployments", - "title": "SuccessfulListDeployments", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "deploymentName": "production", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T16:03:51Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01", - "assignedResources": [ - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "region": "westeurope" - }, - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", - "region": "eastus" - } - ] - }, - { - "deploymentName": "staging", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", - "lastDeployedDateTime": "2022-04-18T15:53:04Z", - "deploymentExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01", - "assignedResources": [ - { - "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", - "region": "westeurope" - } - ] - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListExportedModels.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListExportedModels.json deleted file mode 100644 index 4eebde4aab61..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListExportedModels.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "operationId": "TextAnalysisAuthoringListExportedModels", - "title": "SuccessfulListExportedModels", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "exportedModelName": "exported-model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2023-04-18T15:47:49Z", - "lastExportedModelDateTime": "2023-04-18T16:03:51Z", - "modelExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01" - }, - { - "exportedModelName": "exported-model2", - "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", - "lastTrainedDateTime": "2023-04-18T17:25:22Z", - "lastExportedModelDateTime": "2023-04-18T16:03:51Z", - "modelExpirationDate": "2023-10-28", - "modelTrainingConfigVersion": "2022-05-01" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListModels.json deleted file mode 100644 index be926fa67d9b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListModels.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "operationId": "TextAnalysisAuthoringListTrainedModels", - "title": "SuccessfulListModels", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "label": "model1", - "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", - "lastTrainedDateTime": "2022-04-18T15:47:49Z", - "lastTrainingDurationInSeconds": 186, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01", - "hasSnapshot": true - }, - { - "label": "model2", - "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", - "lastTrainedDateTime": "2022-04-18T17:25:22Z", - "lastTrainingDurationInSeconds": 192, - "modelExpirationDate": "2022-10-28", - "modelTrainingConfigVersion": "2022-05-01", - "hasSnapshot": true - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListProjects.json deleted file mode 100644 index cbcb60295c9f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListProjects.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "operationId": "TextAnalysisAuthoringListProjects", - "title": "SuccessfulListProjects", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "createdDateTime": "2022-04-18T13:53:03Z", - "lastModifiedDateTime": "2022-04-18T13:53:03Z", - "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01Z", - "projectKind": "CustomEntityRecognition", - "storageInputContainerName": "loanagreements", - "projectName": "LoanAgreements", - "multilingual": false, - "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", - "language": "en" - }, - { - "createdDateTime": "2022-04-18T14:03:12Z", - "lastModifiedDateTime": "2022-04-18T14:03:12Z", - "projectKind": "CustomMultiLabelClassification", - "storageInputContainerName": "loanagreements", - "projectName": "MoviesSummary", - "multilingual": false, - "description": "This is a sample dataset adapted from the CMU Movie Summary public dataset. This was prepared by Microsoft Azure Language Services product team to prepare this dataset to be used as a sample for getting started with Custom text classification. This sample dataset consists of 210 files each of them is a movie summary. Each movie can be classified into one or more of the following classes: \"Mystery\", \"Drama\", \"Thriller\", \"Comedy\", \"Action\".", - "language": "en" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json deleted file mode 100644 index bc6d77a8aa83..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json +++ /dev/null @@ -1,89 +0,0 @@ -{ - "operationId": "TextAnalysisAuthoringListTrainingJobs", - "title": "SuccessfulListTrainingJobs", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "result": { - "modelLabel": "model1", - "trainingConfigVersion": "2022-05-01", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T15:45:06.8190649Z", - "endDateTime": "2022-04-18T15:47:19.2639682Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T15:47:19.2734976Z", - "endDateTime": "2022-04-18T15:47:23.8378892Z", - "status": "succeeded" - } - }, - "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", - "createdDateTime": "2022-04-18T15:44:44Z", - "lastUpdatedDateTime": "2022-04-18T15:47:50Z", - "expirationDateTime": "2022-04-25T15:44:44Z", - "status": "succeeded" - }, - { - "result": { - "modelLabel": "model2", - "trainingConfigVersion": "2022-05-01", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:22:39.3663023Z", - "endDateTime": "2022-04-18T17:24:51.9440947Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:24:51.9571747Z", - "endDateTime": "2022-04-18T17:24:58.1427823Z", - "status": "succeeded" - } - }, - "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", - "createdDateTime": "2022-04-18T17:22:11Z", - "lastUpdatedDateTime": "2022-04-18T17:25:23Z", - "expirationDateTime": "2022-04-25T17:22:11Z", - "status": "succeeded" - }, - { - "result": { - "modelLabel": "model2", - "trainingConfigVersion": "2022-05-01", - "trainingStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:44:41.388358Z", - "endDateTime": "2022-04-18T17:50:29.5675101Z", - "status": "succeeded" - }, - "evaluationStatus": { - "percentComplete": 100, - "startDateTime": "2022-04-18T17:50:29.5808461Z", - "endDateTime": "2022-04-18T17:50:35.3482185Z", - "status": "succeeded" - } - }, - "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", - "createdDateTime": "2022-04-18T17:44:04Z", - "lastUpdatedDateTime": "2022-04-18T17:51:11Z", - "expirationDateTime": "2022-04-25T17:44:04Z", - "status": "succeeded" - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulLoadSnapshot.json deleted file mode 100644 index 63f444a486be..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulLoadSnapshot.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "TextAuthoringTrainedModel_LoadSnapshot", - "title": "SuccessfulLoadSnapshot", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "trainedModelLabel": "model1" - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/models/model1/load-snapshot/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulSwapDeployments.json deleted file mode 100644 index 42122e4038db..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulSwapDeployments.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "operationId": "TextAuthoringProject_SwapDeployments", - "title": "SuccessfulSwapDeployments", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "body": { - "firstDeploymentName": "production", - "secondDeploymentName": "staging" - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulTrainProject.json deleted file mode 100644 index 8f8502ec8dc0..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulTrainProject.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "operationId": "TextAuthoringProject_Train", - "title": "SuccessfulTrainProject", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "body": { - "modelLabel": "model1", - "trainingConfigVersion": "latest", - "evaluationOptions": { - "kind": "percentage", - "testingSplitPercentage": 20, - "trainingSplitPercentage": 80 - } - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulUnassignDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulUnassignDeploymentResources.json deleted file mode 100644 index 018904464949..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzetext-authoring/SuccessfulUnassignDeploymentResources.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "TextAuthoringProject_UnassignDeploymentResources", - "title": "SuccessfulUnassignDeploymentResources", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "projectName": "LoanAgreements", - "deploymentName": "production", - "body": { - "assignedResourceIds": [ - "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" - ] - } - }, - "responses": { - "202": { - "headers": { - "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/resources/unassign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulAnalyzeConversations.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulAnalyzeConversations.json deleted file mode 100644 index 1bf52c20be1c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulAnalyzeConversations.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "id": "1", - "participantId": "1", - "text": "play In the air tonight from Phil Collins" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "play In the air tonight from Phil Collins", - "prediction": { - "topIntent": "PlayMusic", - "projectKind": "Conversation", - "intents": [ - { - "category": "PlayMusic", - "confidenceScore": 1 - }, - { - "category": "SearchCreativeWork", - "confidenceScore": 0 - }, - { - "category": "AddToPlaylist", - "confidenceScore": 0 - } - ], - "entities": [ - { - "category": "Media.Artist", - "text": "Phil Collins", - "offset": 29, - "length": 12, - "confidenceScore": 1 - } - ] - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json deleted file mode 100644 index 758e1a5b257f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "participantId": "1", - "id": "1", - "modality": "text", - "language": "en-GB", - "text": "How do I integrate QnA Maker and LUIS?" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "verbose": true, - "isLoggingEnabled": false, - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Rail", - "projectKind": "Orchestration", - "intents": { - "Rail": { - "confidenceScore": 1, - "targetProjectKind": "Conversation", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Timetable", - "projectKind": "Conversation", - "intents": [ - { - "category": "Timetable", - "confidenceScore": 0.99968535 - }, - { - "category": "Locomotive", - "confidenceScore": 0.000314623 - } - ], - "entities": [] - } - } - }, - "Tree": { - "confidenceScore": 0.2641529, - "targetProjectKind": "QuestionAnswering" - }, - "None": { - "confidenceScore": 0, - "targetProjectKind": "NonLinked" - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json deleted file mode 100644 index 07f660e6b80a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "text": "Ports and connectors", - "participantId": "1", - "id": "1" - } - }, - "parameters": { - "projectName": "prj1", - "deploymentName": "dep1", - "directTarget": "qnaProject", - "targetProjectParameters": { - "qnaProject": { - "targetProjectKind": "QuestionAnswering", - "callingOptions": { - "context": { - "previousUserQuery": "Meet Surface Pro 4", - "previousQnaId": 4 - }, - "top": 1, - "question": "App Service overview" - } - } - } - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "Ports and connectors", - "prediction": { - "projectKind": "Orchestration", - "topIntent": "qnaTargetApp", - "intents": { - "qnaTargetApp": { - "targetProjectKind": "QuestionAnswering", - "confidenceScore": 1, - "result": { - "answers": [ - { - "questions": [ - "App Service overview" - ], - "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.", - "confidenceScore": 0.7384000000000001, - "id": 1, - "source": "https://docs.microsoft.com/en-us/azure/app-service/overview", - "metadata": {}, - "dialog": { - "isContextOnly": false, - "prompts": [] - } - } - ] - } - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json deleted file mode 100644 index 0746e1158ebf..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversations/jobs/{jobId}?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIIExclusionSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIIExclusionSubmit.json deleted file mode 100644 index 027262de4eac..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIIExclusionSubmit.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "excludePiiCategories": [ - "Person" - ], - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIIExclusionTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIIExclusionTaskStatusRequest.json deleted file mode 100644 index ea8c6a601d40..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIIExclusionTaskStatusRequest.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "ConversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning *************.", - "itn": "good morning *************", - "maskedItn": "good morning *************", - "lexical": "good morning *************", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIIRedactionCharSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIIRedactionCharSubmit.json deleted file mode 100644 index 5a3e9531fa50..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIIRedactionCharSubmit.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "piiCategories": [ - "All" - ], - "redactionCharacter": "-", - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json deleted file mode 100644 index d630ccc02dbd..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "ConversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning -------------.", - "itn": "good morning -------------", - "maskedItn": "good morning -------------", - "lexical": "good morning -------------", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [ - { - "category": "Person", - "confidenceScore": 0.91, - "length": 8, - "offset": 13, - "text": "john doe" - } - ] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIISubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIISubmit.json deleted file mode 100644 index 2902ec3264e2..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIISubmit.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "piiCategories": [ - "All" - ], - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIITaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIITaskStatusRequest.json deleted file mode 100644 index 590c39ca7e05..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationPIITaskStatusRequest.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "ConversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning *************.", - "itn": "good morning *************", - "maskedItn": "good morning *************", - "lexical": "good morning *************", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [ - { - "category": "Person", - "confidenceScore": 0.91, - "length": 8, - "offset": 13, - "text": "john doe" - } - ] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSentimentSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSentimentSubmit.json deleted file mode 100644 index b3df0f8867cd..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSentimentSubmit.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Sentiment Analysis from a call center conversation", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "I like the service. I do not like the food", - "lexical": "i like the service i do not like the food", - "itn": "", - "maskedItn": "" - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation Sentiment Analysis", - "kind": "ConversationalSentimentTask", - "parameters": { - "modelVersion": "latest", - "predictionSource": "text" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSentimentTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSentimentTaskStatusRequest.json deleted file mode 100644 index ced851481583..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSentimentTaskStatusRequest.json +++ /dev/null @@ -1,60 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-01T15:00:45Z", - "displayName": "Sentiment Analysis from a call center conversation", - "expirationDateTime": "2022-04-01T15:00:45Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-04-01T15:00:45Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "ConversationalSentimentResults", - "taskName": "Conversation Sentiment", - "lastUpdateDateTime": "2022-04-01T15:00:45Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "participantId": "agent_1", - "sentiment": "mixed", - "confidenceScores": { - "positive": 0.5, - "neutral": 0.01, - "negative": 0.49 - } - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2023-04-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskResult.json deleted file mode 100644 index daa02a3023e3..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskResult.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Conversation Summarization Example", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "ConversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "Conversation Summarization Task 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "summaries": [ - { - "aspect": "chapterTitle", - "text": "Bug Triage", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - } - ] - }, - { - "aspect": "narrative", - "text": "Speaker 3 believes there are 3 remaining bugs.", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - }, - { - "conversationItemId": "3", - "offset": 0, - "length": 7 - } - ] - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2023-04-15-preview" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json deleted file mode 100644 index 9a4ce8e11a7a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Analyze chat", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "ConversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "analyze 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "20220101meeting", - "summaries": [ - { - "aspect": "issue", - "text": "Customer wants to cancel his subscription. Customer doesn't know how" - }, - { - "aspect": "resolution", - "text": "pii Auto-Fortify. \npii Gamertag.\npii E-mail.\nCanceled customer's subscription" - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json deleted file mode 100644 index ceae78c89c8e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Conversation Summarization Example", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "conversationItems": [ - { - "participantId": "speaker 1", - "id": "1", - "text": "Let's get started.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 0, - "duration": 20000000 - } - }, - { - "participantId": "speaker 2", - "id": "2", - "text": "OK. How many remaining bugs do we have now?", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 20000000, - "duration": 50000000 - } - }, - { - "participantId": "speaker 3", - "id": "3", - "text": "Only 3.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 50000000, - "duration": 60000000 - } - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation Summarization Task 1", - "kind": "ConversationalSummarizationTask", - "parameters": { - "summaryAspects": [ - "chapterTitle", - "narrative" - ] - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSummarySubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSummarySubmit.json deleted file mode 100644 index 47a483badd0c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulConversationSummarySubmit.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Analyze conversations from Contoso meeting", - "analysisInput": { - "conversations": [ - { - "id": "20220101meeting", - "language": "en", - "modality": "text", - "domain": "generic", - "conversationItems": [ - { - "participantId": "user", - "role": "customer", - "id": "1", - "text": "Hi!" - }, - { - "participantId": "agent", - "role": "agent", - "id": "2", - "text": "Hello, how can I help you?" - }, - { - "participantId": "user", - "role": "customer", - "id": "3", - "text": "I am having trouble issuing a return of a game on my xbox: call of duty" - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "analyze 1", - "kind": "ConversationalSummarizationTask", - "parameters": { - "modelVersion": "latest", - "summaryAspects": [ - "issue", - "resolution" - ] - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulCustomConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulCustomConversationSummarizationTaskResult.json deleted file mode 100644 index 65ef0d442532..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulCustomConversationSummarizationTaskResult.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Custom Conversation Summarization Example", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "CustomConversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "Custom Conversation Summarization Task 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "summaries": [ - { - "aspect": "narrative", - "text": "Speaker 3 believes there are 3 remaining bugs.", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - }, - { - "conversationItemId": "3", - "offset": 0, - "length": 7 - } - ] - } - ], - "warnings": [] - } - ], - "errors": [], - "projectName": "my_project", - "deploymentName": "my_deployment" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulCustomConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulCustomConversationSummarizationTaskSubmit.json deleted file mode 100644 index ffe7a4eb0509..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/conversations/SuccessfulCustomConversationSummarizationTaskSubmit.json +++ /dev/null @@ -1,78 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Custom Conversation Summarization Example", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "conversationItems": [ - { - "participantId": "speaker 1", - "id": "1", - "text": "Let's get started.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 0, - "duration": 20000000 - } - }, - { - "participantId": "speaker 2", - "id": "2", - "text": "OK. How many remaining bugs do we have now?", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 20000000, - "duration": 50000000 - } - }, - { - "participantId": "speaker 3", - "id": "3", - "text": "Only 3.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 50000000, - "duration": 60000000 - } - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Custom Conversation Summarization Task 1", - "kind": "CustomConversationalSummarizationTask", - "parameters": { - "summaryAspects": [ - "narrative" - ], - "projectName": "my_project", - "deploymentName": "my_deployment" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json deleted file mode 100644 index 2cdf4867881c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json +++ /dev/null @@ -1,99 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1", - "deploymentName": "production", - "knowledgeBaseQueryOptions": { - "question": "how long it takes to charge surface?", - "top": 3, - "userId": "sd53lsY=", - "confidenceScoreThreshold": 0.2, - "context": { - "previousQnaId": 9, - "previousUserQuery": "Where are QnA Maker quickstarts?" - }, - "rankerType": "Default", - "filters": { - "metadataFilter": { - "metadata": [ - { - "key": "category", - "value": "api" - }, - { - "key": "editorial", - "value": "chitchat" - } - ], - "logicalOperation": "AND" - }, - "sourceFilter": [ - "filename1.pdf", - "https://www.wikipedia.org/microsoft" - ], - "logicalOperation": "AND" - }, - "answerSpanRequest": { - "enable": true, - "confidenceScoreThreshold": 0.2, - "topAnswersWithSpan": 1 - }, - "includeUnstructuredSources": true - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "answers": [ - { - "questions": [ - "Power and charging" - ], - "answer": "Power and charging**\n\nIt takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.\n\nYou can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface.", - "confidenceScore": 0.65, - "id": 20, - "source": "surface-pro-4-user-guide-EN.pdf", - "metadata": { - "category": "api", - "editorial": "chitchat" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 23, - "displayText": "prompt1" - }, - { - "displayOrder": 2, - "qnaId": 36, - "displayText": "prompt2" - } - ] - }, - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0.3, - "offset": 33, - "length": 50 - } - }, - { - "questions": [ - "Charge your Surface Pro 4" - ], - "answer": "**Charge your Surface Pro 4**\n\n1. Connect the two parts of the power cord.\n\n2. Connect the power cord securely to the charging port.\n\n3. Plug the power supply into an electrical outlet.", - "confidenceScore": 0.32, - "id": 13, - "source": "surface-pro-4-user-guide-EN.pdf" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/SuccessfulQueryText.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/SuccessfulQueryText.json deleted file mode 100644 index 8075cbe4b903..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/SuccessfulQueryText.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "stringIndexType": "TextElements_v8", - "textQueryOptions": { - "question": "how long it takes to charge surface?", - "records": [ - { - "id": "1", - "text": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it." - }, - { - "id": "2", - "text": "You can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface." - } - ], - "language": "en" - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "answers": [ - { - "answer": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", - "confidenceScore": 0.93, - "id": "1", - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0, - "offset": 28, - "length": 45 - }, - "offset": 0, - "length": 224 - }, - { - "answer": "It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", - "confidenceScore": 0.92, - "id": "1", - "answerSpan": { - "text": "two to four hours", - "confidenceScore": 0, - "offset": 8, - "length": 25 - }, - "offset": 20, - "length": 224 - }, - { - "answer": "It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", - "confidenceScore": 0.05, - "id": "1", - "answerSpan": null, - "offset": 110, - "length": 244 - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json deleted file mode 100644 index 278abf52d897..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1", - "body": { - "description": "proj1 is a test project.", - "language": "en", - "settings": { - "defaultAnswer": "No good match found for your question in the Knowledgebase." - }, - "multilingualResource": true - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "settings": { - "defaultAnswer": "No good match found for your question in the Knowledgebase." - }, - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - }, - "201": { - "headers": {}, - "body": { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "settings": { - "defaultAnswer": "No good match found for your question in the Knowledgebase." - }, - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json deleted file mode 100644 index 952c56e291bd..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1" - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/deletion-jobs/job1?api-version=2023-05-01" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulGetProject.json deleted file mode 100644 index c1691bec3c0c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulGetProject.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "settings": { - "defaultAnswer": "No good match found for your question in the Knowledgebase." - }, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json deleted file mode 100644 index 88447526d3b0..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": 1, - "answer": "ans1", - "source": "source1", - "questions": [ - "question 1.1", - "question 1.2" - ], - "metadata": { - "k1": "v1", - "k2": "v2" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 11, - "displayText": "prompt 1.1" - }, - { - "displayOrder": 2, - "qnaId": 21, - "displayText": "prompt 1.2" - } - ] - }, - "lastUpdatedDateTime": "2021-05-01T17:21:14Z" - }, - { - "id": 2, - "answer": "ans2", - "source": "source2", - "questions": [ - "question 2.1", - "question 2.2" - ], - "lastUpdatedDateTime": "2021-05-01T17:21:14Z" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulGetSources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulGetSources.json deleted file mode 100644 index 3ace7722ca2b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulGetSources.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "displayName": "source1", - "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview", - "sourceKind": "url", - "lastUpdatedDateTime": "2021-05-01T15:13:22Z", - "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview" - }, - { - "displayName": "source2", - "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf", - "sourceKind": "file", - "contentStructureKind": "unstructured", - "lastUpdatedDateTime": "2021-05-01T15:13:22Z", - "source": "surface-guide.pdf" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json deleted file mode 100644 index b9dc7f571ea7..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "alterations": [ - "qnamaker", - "qna maker" - ] - }, - { - "alterations": [ - "botframework", - "bot framework" - ] - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json deleted file mode 100644 index 70cd81f4bd32..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json deleted file mode 100644 index 7b4ec56725b6..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1", - "deploymentName": "production", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json deleted file mode 100644 index 90dfc5188381..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded", - "resultUrl": "https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json deleted file mode 100644 index 6594867e0698..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json deleted file mode 100644 index 4e7a8e5fb484..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "deploymentName": "production", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json deleted file mode 100644 index d3fdec2b1aa8..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1", - "deploymentName": "production" - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/deployments/production/jobs/job1?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json deleted file mode 100644 index c3321b2de17a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1", - "body": { - "exportAssetTypes": [ - "qnas", - "synonyms" - ] - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded", - "resultUrl": "https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2023-04-15-preview" - } - }, - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json deleted file mode 100644 index 145cf82290eb..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json +++ /dev/null @@ -1,73 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1", - "body": { - "assets": { - "synonyms": [ - { - "alterations": [ - "wa", - "washington", - "washington state" - ] - }, - { - "alterations": [ - "U.S", - "usa", - "united states of america" - ] - } - ], - "qnas": [ - { - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "id": 1, - "answer": "ans1", - "source": "source1", - "questions": [ - "question 1.1", - "question 1.2" - ], - "metadata": { - "k1": "v1", - "k2": "v2" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 2, - "displayText": "prompt 1.1" - } - ] - } - }, - { - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "id": 2, - "answer": "ans2", - "source": "source2", - "questions": [ - "question 2.1", - "question 2.2" - ] - } - ] - } - } - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/import/jobs/job1?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json deleted file mode 100644 index 238e2e2041be..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "projectName": "proj1", - "description": "proj1 is a test project.", - "language": "en", - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - }, - { - "projectName": "proj2", - "description": "proj2 is a test project.", - "language": "fr", - "multilingualResource": true, - "createdDateTime": "2021-05-01T15:13:22Z", - "lastModifiedDateTime": "2021-05-01T15:13:22Z", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json deleted file mode 100644 index f2d0f6f86fb4..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1", - "body": { - "records": [ - { - "userId": "user1", - "userQuestion": "hi", - "qnaId": 1 - }, - { - "userId": "user1", - "userQuestion": "hello", - "qnaId": 2 - } - ] - } - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json deleted file mode 100644 index 38ec4e04be5a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1", - "body": [ - { - "op": "add", - "value": { - "id": 3, - "answer": "ans3", - "source": "source1", - "questions": [ - "question 3.1", - "question 3.2" - ], - "metadata": { - "k1": "v1", - "k2": "v2" - }, - "dialog": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "qnaId": 11, - "displayText": "prompt 3.1" - }, - { - "displayOrder": 2, - "qnaId": 21, - "displayText": "prompt 3.2" - } - ] - } - } - }, - { - "op": "replace", - "value": { - "id": 1, - "answer": "ans4", - "source": "source1", - "questions": [ - "question 4.1", - "question 4.2" - ] - } - }, - { - "op": "delete", - "value": { - "id": 2, - "answer": "ans2", - "source": "source1", - "questions": [ - "question 2.1", - "question 2.2" - ] - } - } - ] - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/qnas/jobs/job1?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json deleted file mode 100644 index 6594867e0698..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json deleted file mode 100644 index 5dd49075819a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1", - "body": [ - { - "op": "add", - "value": { - "displayName": "source3", - "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context", - "sourceKind": "url", - "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context" - } - }, - { - "op": "replace", - "value": { - "displayName": "source1", - "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview", - "sourceKind": "url", - "refresh": true, - "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview" - } - }, - { - "op": "delete", - "value": { - "displayName": "source2", - "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf", - "sourceKind": "file", - "source": "surface-guide.pdf" - } - } - ] - }, - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", - "headers": { - "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/sources/jobs/job1?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json deleted file mode 100644 index 6594867e0698..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1", - "jobId": "job1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "errors": [], - "createdDateTime": "2021-05-01T17:21:14Z", - "expirationDateTime": "2021-05-01T17:21:14Z", - "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", - "lastUpdatedDateTime": "2021-05-01T17:21:14Z", - "status": "succeeded" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json deleted file mode 100644 index 8314ca12daf9..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-04-15-preview", - "projectName": "proj1", - "body": { - "value": [ - { - "alterations": [ - "qnamaker", - "qna maker" - ] - }, - { - "alterations": [ - "botframework", - "bot framework" - ] - } - ] - } - }, - "responses": { - "204": {} - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfuDynamicClassificationRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfuDynamicClassificationRequest.json deleted file mode 100644 index 69bac4022a30..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfuDynamicClassificationRequest.json +++ /dev/null @@ -1,92 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "DynamicClassification", - "parameters": { - "categories": [ - "Health", - "Politics", - "Music", - "Sports" - ], - "classificationType": "Multi", - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "The WHO is issuing a warning about Monkey Pox." - }, - { - "id": "2", - "language": "en", - "text": "Mo Salah plays in Liverpool FC in England." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "DynamicClassificationResults", - "results": { - "documents": [ - { - "id": "1", - "classifications": [ - { - "category": "Health", - "confidenceScore": 0.9 - }, - { - "category": "Politics", - "confidenceScore": 0.8 - }, - { - "category": "Music", - "confidenceScore": 0.7 - }, - { - "category": "Sports", - "confidenceScore": 0.6 - } - ], - "warnings": [] - }, - { - "id": "2", - "classifications": [ - { - "category": "Health", - "confidenceScore": 0.9 - }, - { - "category": "Politics", - "confidenceScore": 0.8 - }, - { - "category": "Music", - "confidenceScore": 0.7 - }, - { - "category": "Sports", - "confidenceScore": 0.6 - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2023-04-15-preview" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulAbstractiveSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulAbstractiveSummarizationTaskResult.json deleted file mode 100644 index 96abfdcbf463..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulAbstractiveSummarizationTaskResult.json +++ /dev/null @@ -1,56 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Document Abstractive Summarization Task Example", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "AbstractiveSummarizationLROResults", - "taskName": "Document Abstractive Summarization Task 1", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "summaries": [ - { - "text": "Microsoft have been on a quest to advance AI beyond existing techniques.", - "contexts": [ - { - "offset": 0, - "length": 1629 - } - ] - } - ], - "id": "1", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2023-04-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.json deleted file mode 100644 index 451b4ff224f5..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Document Abstractive Summarization Task Example", - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks." - } - ] - }, - "tasks": [ - { - "kind": "AbstractiveSummarization", - "taskName": "Document Abstractive Summarization Task 1", - "parameters": { - "sentenceCount": 1 - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulAnalyzeTextJobsCancelRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulAnalyzeTextJobsCancelRequest.json deleted file mode 100644 index d51e3dfac47e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulAnalyzeTextJobsCancelRequest.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json deleted file mode 100644 index 40daeebd7e0c..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json +++ /dev/null @@ -1,178 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Extracting Location & US Region", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 2, - "failed": 0, - "inProgress": 0, - "total": 2, - "items": [ - { - "kind": "EntityRecognitionLROResults", - "taskName": "Recognize Entities", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "entities": [ - { - "category": "Event", - "type": "Event", - "confidenceScore": 0.61, - "length": 4, - "offset": 18, - "text": "trip", - "tags": [ - { - "name": "Event", - "confidenceScore": 0.61 - } - ] - }, - { - "category": "Location", - "type": "GPE", - "confidenceScore": 0.82, - "length": 7, - "offset": 26, - "tags": [ - { - "name": "Location", - "confidenceScore": 0.82 - }, - { - "name": "GPE", - "confidenceScore": 0.82 - } - ], - "text": "Seattle" - }, - { - "category": "Temporal", - "type": "DateRange", - "confidenceScore": 0.8, - "length": 9, - "offset": 34, - "text": "last week", - "tags": [ - { - "name": "DateRange", - "confidenceScore": 0.8 - }, - { - "name": "Temporal", - "confidenceScore": 0.8 - } - ] - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "Location", - "type": "GPE", - "confidenceScore": 0.52, - "length": 3, - "offset": 14, - "text": "NYC", - "tags": [ - { - "name": "Location", - "confidenceScore": 0.82 - }, - { - "name": "GPE", - "confidenceScore": 0.82 - } - ] - }, - { - "category": "Temporal", - "type": "Date", - "confidenceScore": 0.8, - "length": 8, - "offset": 18, - "text": "tomorrow", - "tags": [ - { - "name": "Date", - "confidenceScore": 0.8 - }, - { - "name": "Temporal", - "confidenceScore": 0.8 - } - ] - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-04-01" - } - }, - { - "kind": "CustomEntityRecognitionLROResults", - "taskName": "Recognize US Regions", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "entities": [ - { - "category": "USRegion", - "confidenceScore": 0.85, - "length": 17, - "offset": 45, - "text": "Pacific Northwest" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "category": "USRegion", - "confidenceScore": 0.88, - "length": 10, - "offset": 63, - "text": "East Coast" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "projectName": "MyProject", - "deploymentName": "MyDeployment" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json deleted file mode 100644 index 908cc3b28f8d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Extracting Location & US Region", - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "I had a wonderful trip to Seattle last week." - }, - { - "id": "2", - "language": "en", - "text": "I'm flying to NYC tomorrow. See you there." - } - ] - }, - "tasks": [ - { - "kind": "EntityRecognition", - "taskName": "Recognize Entities", - "parameters": { - "modelVersion": "latest" - } - }, - { - "kind": "CustomEntityRecognition", - "taskName": "Recognize US Regions", - "parameters": { - "projectName": "MyProject", - "deploymentName": "MyDeployment" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomAbstractiveSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomAbstractiveSummarizationTaskResult.json deleted file mode 100644 index 7dd628c4183e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomAbstractiveSummarizationTaskResult.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Document Custom Abstractive Summarization Task Example", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "CustomAbstractiveSummarizationLROResults", - "taskName": "Custom Document Abstractive Summarization Task 1", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "summaries": [ - { - "text": "Microsoft have been on a quest to advance AI beyond existing techniques.", - "contexts": [ - { - "offset": 0, - "length": 1629 - } - ] - } - ], - "id": "1", - "warnings": [] - } - ], - "errors": [], - "projectName": "my_project", - "deploymentName": "my_deployment" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomAbstractiveSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomAbstractiveSummarizationTaskSubmit.json deleted file mode 100644 index 885985d0e453..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomAbstractiveSummarizationTaskSubmit.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Document Custom Abstractive Summarization Task Example", - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks." - } - ] - }, - "tasks": [ - { - "kind": "CustomAbstractiveSummarization", - "taskName": "Custom Document Abstractive Summarization Task 1", - "parameters": { - "projectName": "my_project", - "deploymentName": "my_deployment" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomHealthcarePostRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomHealthcarePostRequest.json deleted file mode 100644 index 6086f030e84e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomHealthcarePostRequest.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "analysisInput": { - "documents": [ - { - "text": "Prescribed 100mg ibuprofen, taken twice daily.", - "id": "1", - "language": "en" - } - ] - }, - "tasks": [ - { - "kind": "CustomHealthcare", - "parameters": { - "projectName": "{PROJECT-NAME}", - "deploymentName": "{DEPLOYMENT-NAME}" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-04-01" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomHealthcareTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomHealthcareTaskStatusRequest.json deleted file mode 100644 index 8a265d69d6dd..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomHealthcareTaskStatusRequest.json +++ /dev/null @@ -1,251 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-07-20T18:43:35Z", - "displayName": "Extracting Custom Health Entities", - "expirationDateTime": "2022-07-21T18:43:35Z", - "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0", - "lastUpdatedDateTime": "2022-07-20T18:43:36Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "CustomHealthcareLROResults", - "lastUpdateDateTime": "2022-07-20T18:43:36.7159045Z", - "status": "succeeded", - "results": { - "documents": [ - { - "id": "1", - "entities": [ - { - "offset": 11, - "length": 5, - "text": "100mg", - "category": "Dosage", - "confidenceScore": 0.98, - "entityComponentInformation": [ - { - "entityComponentKind": "PrebuiltComponent", - "value": "Dosage.Prebuilt" - }, - { - "entityComponentKind": "ListComponent", - "value": "ListKey" - } - ] - }, - { - "offset": 17, - "length": 9, - "text": "ibuprofen", - "category": "MedicationName", - "confidenceScore": 1, - "name": "ibuprofen", - "entityComponentInformation": [ - { - "entityComponentKind": "ListComponent", - "value": "ListKey" - } - ] - }, - { - "offset": 34, - "length": 11, - "text": "twice daily", - "category": "Frequency", - "confidenceScore": 1, - "entityComponentInformation": [ - { - "entityComponentKind": "LearnedComponent", - "value": "Frequency.Learned" - } - ] - }, - { - "offset": 17, - "length": 9, - "text": "ibuprofen", - "category": "MedicationName", - "confidenceScore": 1, - "name": "ibuprofen", - "links": [ - { - "dataSource": "UMLS", - "id": "C0020740" - }, - { - "dataSource": "AOD", - "id": "0000019879" - }, - { - "dataSource": "ATC", - "id": "M01AE01" - }, - { - "dataSource": "CCPSS", - "id": "0046165" - }, - { - "dataSource": "CHV", - "id": "0000006519" - }, - { - "dataSource": "CSP", - "id": "2270-2077" - }, - { - "dataSource": "DRUGBANK", - "id": "DB01050" - }, - { - "dataSource": "GS", - "id": "1611" - }, - { - "dataSource": "LCH_NW", - "id": "sh97005926" - }, - { - "dataSource": "LNC", - "id": "LP16165-0" - }, - { - "dataSource": "MEDCIN", - "id": "40458" - }, - { - "dataSource": "MMSL", - "id": "d00015" - }, - { - "dataSource": "MSH", - "id": "D007052" - }, - { - "dataSource": "MTHSPL", - "id": "WK2XYI10QM" - }, - { - "dataSource": "NCI", - "id": "C561" - }, - { - "dataSource": "NCI_CTRP", - "id": "C561" - }, - { - "dataSource": "NCI_DCP", - "id": "00803" - }, - { - "dataSource": "NCI_DTP", - "id": "NSC0256857" - }, - { - "dataSource": "NCI_FDA", - "id": "WK2XYI10QM" - }, - { - "dataSource": "NCI_NCI-GLOSS", - "id": "CDR0000613511" - }, - { - "dataSource": "NDDF", - "id": "002377" - }, - { - "dataSource": "PDQ", - "id": "CDR0000040475" - }, - { - "dataSource": "RCD", - "id": "x02MO" - }, - { - "dataSource": "RXNORM", - "id": "5640" - }, - { - "dataSource": "SNM", - "id": "E-7772" - }, - { - "dataSource": "SNMI", - "id": "C-603C0" - }, - { - "dataSource": "SNOMEDCT_US", - "id": "387207008" - }, - { - "dataSource": "USP", - "id": "m39860" - }, - { - "dataSource": "USPMG", - "id": "MTHU000060" - }, - { - "dataSource": "VANDF", - "id": "4017840" - } - ] - } - ], - "relations": [ - { - "confidenceScore": 1, - "relationType": "DosageOfMedication", - "entities": [ - { - "ref": "#/results/documents/0/entities/0", - "role": "Dosage" - }, - { - "ref": "#/results/documents/0/entities/1", - "role": "Medication" - } - ] - }, - { - "confidenceScore": 1, - "relationType": "FrequencyOfMedication", - "entities": [ - { - "ref": "#/results/documents/0/entities/1", - "role": "Medication" - }, - { - "ref": "#/results/documents/0/entities/2", - "role": "Frequency" - } - ] - } - ], - "warnings": [] - } - ], - "errors": [], - "projectName": "{PROJECT-NAME}", - "deploymentName": "{DEPLOYMENT-NAME}" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomSentimentAnalysisTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomSentimentAnalysisTaskStatusRequest.json deleted file mode 100644 index 61165db6d09f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomSentimentAnalysisTaskStatusRequest.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "29fe5bb0-83ae-4f86-85d6-775534dcd2d4" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2023-02-05T20:45:15Z", - "displayName": "Custom Sentiment Analysis Job", - "expirationDateTime": "2023-02-06T20:45:15Z", - "jobId": "29fe5bb0-83ae-4f86-85d6-775534dcd2d4", - "lastUpdatedDateTime": "2023-02-05T20:46:05Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "CustomSentimentAnalysisLROResults", - "lastUpdateDateTime": "2023-02-05T20:46:05Z", - "status": "succeeded", - "results": { - "documents": [ - { - "id": "1", - "sentiment": "mixed", - "confidenceScores": { - "positive": 0.5, - "neutral": 0.0, - "negative": 0.5 - }, - "sentences": [ - { - "sentiment": "positive", - "confidenceScores": { - "positive": 1.0, - "neutral": 0.0, - "negative": 0.0 - }, - "offset": 0, - "length": 19, - "text": "The food is great. " - }, - { - "sentiment": "negative", - "confidenceScores": { - "positive": 0.0, - "neutral": 0.0, - "negative": 1.0 - }, - "offset": 19, - "length": 23, - "text": "But the service is bad." - } - ], - "warnings": [] - } - ], - "errors": [], - "projectName": "{PROJECT-NAME}", - "deploymentName": "{DEPLOYMENT-NAME}" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomSentimentAnalysisTaskSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomSentimentAnalysisTaskSubmit.json deleted file mode 100644 index 724e588fdfd2..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulCustomSentimentAnalysisTaskSubmit.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "analysisInput": { - "documents": [ - { - "text": "The food is great. But the service is bad.", - "id": "1", - "language": "en" - } - ] - }, - "tasks": [ - { - "kind": "CustomSentimentAnalysis", - "parameters": { - "projectName": "{PROJECT-NAME}", - "deploymentName": "{DEPLOYMENT-NAME}" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulEntityLinkingRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulEntityLinkingRequest.json deleted file mode 100644 index 196844eb3ae6..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulEntityLinkingRequest.json +++ /dev/null @@ -1,128 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "EntityLinking", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Microsoft was founded by Bill Gates and Paul Allen." - }, - { - "id": "2", - "language": "en", - "text": "Pike place market is my favorite Seattle attraction." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "EntityLinkingResults", - "results": { - "documents": [ - { - "entities": [ - { - "dataSource": "Wikipedia", - "id": "Bill Gates", - "language": "en", - "matches": [ - { - "confidenceScore": 0.52, - "length": 10, - "offset": 25, - "text": "Bill Gates" - } - ], - "name": "Bill Gates", - "url": "https://en.wikipedia.org/wiki/Bill_Gates" - }, - { - "dataSource": "Wikipedia", - "id": "Paul Allen", - "language": "en", - "matches": [ - { - "confidenceScore": 0.54, - "length": 10, - "offset": 40, - "text": "Paul Allen" - } - ], - "name": "Paul Allen", - "url": "https://en.wikipedia.org/wiki/Paul_Allen" - }, - { - "dataSource": "Wikipedia", - "id": "Microsoft", - "language": "en", - "matches": [ - { - "confidenceScore": 0.49, - "length": 9, - "offset": 0, - "text": "Microsoft" - } - ], - "name": "Microsoft", - "url": "https://en.wikipedia.org/wiki/Microsoft" - } - ], - "id": "1", - "warnings": [] - }, - { - "entities": [ - { - "dataSource": "Wikipedia", - "id": "Pike Place Market", - "language": "en", - "matches": [ - { - "confidenceScore": 0.86, - "length": 17, - "offset": 0, - "text": "Pike place market" - } - ], - "name": "Pike Place Market", - "url": "https://en.wikipedia.org/wiki/Pike_Place_Market" - }, - { - "dataSource": "Wikipedia", - "id": "Seattle", - "language": "en", - "matches": [ - { - "confidenceScore": 0.27, - "length": 7, - "offset": 33, - "text": "Seattle" - } - ], - "name": "Seattle", - "url": "https://en.wikipedia.org/wiki/Seattle" - } - ], - "id": "2", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2020-02-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulEntityRecognitionExclusionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulEntityRecognitionExclusionRequest.json deleted file mode 100644 index e3806e7fa0d8..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulEntityRecognitionExclusionRequest.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "EntityRecognition", - "parameters": { - "modelVersion": "latest", - "exclusionList": [ - "Numeric" - ], - "overlapPolicy": { - "policyKind": "allowOverlap" - } - }, - "analysisInput": { - "documents": [ - { - "id": "2", - "language": "en", - "text": "When I was 5 years old I had $90.00 dollars to my name." - }, - { - "id": "3", - "language": "en", - "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "EntityRecognitionResults", - "results": { - "documents": [ - { - "entities": [], - "id": "2", - "warnings": [] - }, - { - "entities": [ - { - "text": "LAX", - "category": "Location", - "type": "Airport", - "offset": 18, - "length": 3, - "confidenceScore": 0.72, - "tags": [ - { - "name": "Location", - "confidenceScore": 0.9 - }, - { - "name": "Structural", - "confidenceScore": 0.72 - } - ] - }, - { - "text": "Amsterdam", - "category": "Location", - "type": "City", - "offset": 96, - "length": 9, - "confidenceScore": 0.8, - "tags": [ - { - "name": "Location", - "confidenceScore": 0.84 - }, - { - "name": "GPE", - "confidenceScore": 0.84 - }, - { - "name": "City", - "confidenceScore": 0.8 - } - ] - }, - { - "text": "Eiffel Tower", - "category": "Location", - "type": "Structural", - "offset": 107, - "length": 12, - "confidenceScore": 0.9, - "tags": [ - { - "name": "Location", - "confidenceScore": 0.9 - }, - { - "name": "Structural", - "confidenceScore": 0.9 - } - ] - }, - { - "text": "Nile", - "category": "Location", - "type": "Geological", - "offset": 129, - "length": 4, - "confidenceScore": 0.63, - "tags": [ - { - "name": "Location", - "confidenceScore": 0.9 - }, - { - "name": "Geological", - "confidenceScore": 0.63 - } - ] - } - ], - "id": "3", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-06-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulEntityRecognitionInclusionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulEntityRecognitionInclusionRequest.json deleted file mode 100644 index 718c27b7676f..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulEntityRecognitionInclusionRequest.json +++ /dev/null @@ -1,131 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "EntityRecognition", - "parameters": { - "modelVersion": "latest", - "inclusionList": [ - "Location" - ] - }, - "analysisInput": { - "documents": [ - { - "id": "2", - "language": "en", - "text": "When I was 5 years old I had $90.00 dollars to my name." - }, - { - "id": "3", - "language": "en", - "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "EntityRecognitionResults", - "results": { - "documents": [ - { - "entities": [], - "id": "2", - "warnings": [] - }, - { - "entities": [ - { - "text": "LAX", - "category": "Location", - "type": "Structural", - "offset": 18, - "length": 3, - "confidenceScore": 0.72, - "tags": [ - { - "name": "Location", - "confidenceScore": 0.9 - }, - { - "name": "Structural", - "confidenceScore": 0.72 - } - ] - }, - { - "text": "Amsterdam", - "category": "Location", - "type": "City", - "offset": 96, - "length": 9, - "confidenceScore": 0.8, - "tags": [ - { - "name": "Location", - "confidenceScore": 0.84 - }, - { - "name": "GPE", - "confidenceScore": 0.84 - }, - { - "name": "City", - "confidenceScore": 0.8 - } - ] - }, - { - "text": "Eiffel Tower", - "category": "Location", - "type": "Structural", - "offset": 107, - "length": 12, - "confidenceScore": 0.9, - "tags": [ - { - "name": "Location", - "confidenceScore": 0.9 - }, - { - "name": "Structural", - "confidenceScore": 0.9 - } - ] - }, - { - "text": "Nile", - "category": "Location", - "type": "Geological", - "offset": 129, - "length": 4, - "confidenceScore": 0.63, - "tags": [ - { - "name": "Location", - "confidenceScore": 0.9 - }, - { - "name": "Geological", - "confidenceScore": 0.63 - } - ] - } - ], - "id": "3", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-06-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulEntityRecognitionOverlapPolicy.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulEntityRecognitionOverlapPolicy.json deleted file mode 100644 index 358908ca9a28..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulEntityRecognitionOverlapPolicy.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "EntityRecognition", - "parameters": { - "modelVersion": "latest", - "overlapPolicy": { - "policyKind": "matchLongest" - } - }, - "analysisInput": { - "documents": [ - { - "id": "4", - "language": "en", - "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup" - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "EntityRecognitionResults", - "results": { - "documents": [ - { - "entities": [ - { - "text": "25th April Meeting", - "category": "Event", - "type": "Event", - "offset": 0, - "length": 18, - "confidenceScore": 0.59, - "tags": [ - { - "name": "Event", - "confidenceScore": 0.59 - } - ] - }, - { - "text": "Worldcup", - "category": "Event", - "type": "SportsEvent", - "offset": 0, - "length": 8, - "confidenceScore": 0.51, - "tags": [ - { - "name": "Event", - "confidenceScore": 0.55 - }, - { - "name": "SportsEvent", - "confidenceScore": 0.51 - } - ] - } - ], - "id": "4", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-06-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulEntityRecognitionRequest.json deleted file mode 100644 index 1ee4a9007c5b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulEntityRecognitionRequest.json +++ /dev/null @@ -1,337 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "EntityRecognition", - "parameters": { - "modelVersion": "latest", - "overlapPolicy": { - "policyKind": "allowOverlap" - } - }, - "analysisInput": { - "documents": [ - { - "id": "2", - "language": "en", - "text": "When I was 5 years old I had $90.00 dollars to my name." - }, - { - "id": "3", - "language": "en", - "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." - }, - { - "id": "4", - "language": "en", - "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup" - }, - { - "id": "5", - "language": "en", - "text": "My IP is 127.12.1.1 and my phone number is 5555555555" - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "EntityRecognitionResults", - "results": { - "documents": [ - { - "entities": [ - { - "text": "5 years old", - "category": "Numeric", - "type": "Age", - "offset": 11, - "length": 11, - "confidenceScore": 0.99, - "tags": [ - { - "name": "Numeric", - "confidenceScore": 0.99 - }, - { - "name": "Age", - "confidenceScore": 0.99 - } - ], - "metadata": { - "metadataKind": "AgeMetadata", - "unit": "Year", - "value": 5.0 - } - }, - { - "text": "$90.00", - "category": "Numeric", - "type": "Currency", - "offset": 29, - "length": 14, - "confidenceScore": 0.99, - "tags": [ - { - "name": "Numeric", - "confidenceScore": 0.99 - }, - { - "name": "Currency", - "confidenceScore": 0.99 - } - ], - "metadata": { - "metadataKind": "CurrencyMetadata", - "unit": "Dollar", - "iso4217": "USD", - "value": 90.0 - } - } - ], - "id": "2", - "warnings": [] - }, - { - "entities": [ - { - "text": "LAX", - "category": "Location", - "type": "Structural", - "offset": 18, - "length": 3, - "confidenceScore": 0.72, - "tags": [ - { - "name": "Location", - "confidenceScore": 0.9 - }, - { - "name": "Structural", - "confidenceScore": 0.72 - } - ] - }, - { - "text": "10 meters per second", - "category": "Numeric", - "type": "Speed", - "offset": 55, - "length": 20, - "confidenceScore": 0.8, - "tags": [ - { - "name": "Dimension", - "confidenceScore": 0.84 - }, - { - "name": "Numeric", - "confidenceScore": 0.84 - }, - { - "name": "Speed", - "confidenceScore": 0.8 - } - ], - "metadata": { - "metadataKind": "SpeedMetadata", - "unit": "MetersPerSecond", - "value": 10.0 - } - }, - { - "text": "Amsterdam", - "category": "Location", - "type": "City", - "offset": 96, - "length": 9, - "confidenceScore": 0.8, - "tags": [ - { - "name": "Location", - "confidenceScore": 0.84 - }, - { - "name": "GPE", - "confidenceScore": 0.84 - }, - { - "name": "City", - "confidenceScore": 0.8 - } - ] - }, - { - "text": "Eiffel Tower", - "category": "Location", - "type": "Structural", - "offset": 107, - "length": 12, - "confidenceScore": 0.9, - "tags": [ - { - "name": "Location", - "confidenceScore": 0.9 - }, - { - "name": "Structural", - "confidenceScore": 0.9 - } - ] - }, - { - "text": "Nile", - "category": "Location", - "type": "Geological", - "offset": 129, - "length": 4, - "confidenceScore": 0.63, - "tags": [ - { - "name": "Location", - "confidenceScore": 0.9 - }, - { - "name": "Geological", - "confidenceScore": 0.63 - } - ] - } - ], - "id": "3", - "warnings": [] - }, - { - "entities": [ - { - "text": "25th April", - "category": "Temporal", - "type": "Date", - "offset": 0, - "length": 10, - "confidenceScore": 0.58, - "tags": [ - { - "name": "Temporal", - "confidenceScore": 0.9 - }, - { - "name": "Date", - "confidenceScore": 0.58 - } - ], - "metadata": { - "metadataKind": "DateMetadata", - "dateValues": [ - { - "timex": "XXXX-04-25", - "value": "2022-04-25" - }, - { - "timex": "XXXX-04-25", - "value": "2023-04-25" - } - ] - } - }, - { - "text": "25th April Meeting", - "category": "Event", - "type": "Event", - "offset": 0, - "length": 18, - "confidenceScore": 0.55, - "tags": [ - { - "name": "Event", - "confidenceScore": 0.55 - } - ] - }, - { - "text": "25th April Meeting", - "category": "Event", - "type": "CulturalEvent", - "offset": 0, - "length": 18, - "confidenceScore": 0.55, - "tags": [ - { - "name": "Event", - "confidenceScore": 0.55 - }, - { - "name": "CulturalEvent", - "confidenceScore": 0.55 - } - ] - }, - { - "text": "Worldcup", - "category": "Event", - "type": "SportsEvent", - "offset": 0, - "length": 8, - "confidenceScore": 0.51, - "tags": [ - { - "name": "Event", - "confidenceScore": 0.55 - }, - { - "name": "SportsEvent", - "confidenceScore": 0.51 - } - ] - } - ], - "id": "4", - "warnings": [] - }, - { - "entities": [ - { - "text": "127.12.1.1", - "category": "IP", - "type": "IP", - "offset": 9, - "length": 10, - "confidenceScore": 0.8, - "tags": [ - { - "name": "IP", - "confidenceScore": 0.8 - } - ] - }, - { - "text": "5555555555", - "category": "PhoneNumber", - "type": "PhoneNumber", - "offset": 45, - "length": 9, - "confidenceScore": 0.8, - "tags": [ - { - "name": "PhoneNumber", - "confidenceScore": 0.8 - } - ] - } - ], - "id": "5", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-06-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulHealthcareDocumentTypePostRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulHealthcareDocumentTypePostRequest.json deleted file mode 100644 index 4b6569464424..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulHealthcareDocumentTypePostRequest.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "analysisInput": { - "documents": [ - { - "text": "Prescribed 100mg ibuprofen, taken twice daily.", - "id": "1", - "language": "en" - } - ] - }, - "tasks": [ - { - "kind": "Healthcare", - "parameters": { - "modelVersion": "latest", - "fhirVersion": "4.0.1", - "documentType": "DischargeSummary" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json deleted file mode 100644 index f6d3826d51cb..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json +++ /dev/null @@ -1,552 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "15e4a46b-62e2-4386-8d36-9c2a92bb45dd" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-09-06T23:47:43Z", - "displayName": "Providing Document Type", - "expirationDateTime": "2022-09-07T23:47:43Z", - "jobId": "15e4a46b-62e2-4386-8d36-9c2a92bb45dd", - "lastUpdatedDateTime": "2022-09-06T23:48:10Z", - "status": "succeeded", - "errors": [], - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "HealthcareLROResults", - "lastUpdateDateTime": "2022-09-06T23:48:10.1762027Z", - "status": "succeeded", - "results": { - "documents": [ - { - "id": "a", - "entities": [ - { - "offset": 11, - "length": 5, - "text": "100mg", - "category": "Dosage", - "confidenceScore": 0.98 - }, - { - "offset": 17, - "length": 9, - "text": "ibuprofen", - "category": "MedicationName", - "confidenceScore": 1.0, - "name": "ibuprofen", - "links": [ - { - "dataSource": "UMLS", - "id": "C0020740" - }, - { - "dataSource": "AOD", - "id": "0000019879" - }, - { - "dataSource": "ATC", - "id": "M01AE01" - }, - { - "dataSource": "CCPSS", - "id": "0046165" - }, - { - "dataSource": "CHV", - "id": "0000006519" - }, - { - "dataSource": "CSP", - "id": "2270-2077" - }, - { - "dataSource": "DRUGBANK", - "id": "DB01050" - }, - { - "dataSource": "GS", - "id": "1611" - }, - { - "dataSource": "LCH_NW", - "id": "sh97005926" - }, - { - "dataSource": "LNC", - "id": "LP16165-0" - }, - { - "dataSource": "MEDCIN", - "id": "40458" - }, - { - "dataSource": "MMSL", - "id": "d00015" - }, - { - "dataSource": "MSH", - "id": "D007052" - }, - { - "dataSource": "MTHSPL", - "id": "WK2XYI10QM" - }, - { - "dataSource": "NCI", - "id": "C561" - }, - { - "dataSource": "NCI_CTRP", - "id": "C561" - }, - { - "dataSource": "NCI_DCP", - "id": "00803" - }, - { - "dataSource": "NCI_DTP", - "id": "NSC0256857" - }, - { - "dataSource": "NCI_FDA", - "id": "WK2XYI10QM" - }, - { - "dataSource": "NCI_NCI-GLOSS", - "id": "CDR0000613511" - }, - { - "dataSource": "NDDF", - "id": "002377" - }, - { - "dataSource": "PDQ", - "id": "CDR0000040475" - }, - { - "dataSource": "RCD", - "id": "x02MO" - }, - { - "dataSource": "RXNORM", - "id": "5640" - }, - { - "dataSource": "SNM", - "id": "E-7772" - }, - { - "dataSource": "SNMI", - "id": "C-603C0" - }, - { - "dataSource": "SNOMEDCT_US", - "id": "387207008" - }, - { - "dataSource": "USP", - "id": "m39860" - }, - { - "dataSource": "USPMG", - "id": "MTHU000060" - }, - { - "dataSource": "VANDF", - "id": "4017840" - } - ] - }, - { - "offset": 34, - "length": 11, - "text": "twice daily", - "category": "Frequency", - "confidenceScore": 1.0 - } - ], - "relations": [ - { - "confidenceScore": 1.0, - "relationType": "DosageOfMedication", - "entities": [ - { - "ref": "#/results/documents/0/entities/0", - "role": "Dosage" - }, - { - "ref": "#/results/documents/0/entities/1", - "role": "Medication" - } - ] - }, - { - "confidenceScore": 1.0, - "relationType": "FrequencyOfMedication", - "entities": [ - { - "ref": "#/results/documents/0/entities/1", - "role": "Medication" - }, - { - "ref": "#/results/documents/0/entities/2", - "role": "Frequency" - } - ] - } - ], - "warnings": [], - "fhirBundle": { - "resourceType": "Bundle", - "id": "6ee4a7c0-5911-4c4b-bea2-3c2a1fe5c65f", - "meta": { - "profile": [ - "http://hl7.org/fhir/4.0.1/StructureDefinition/Bundle" - ] - }, - "identifier": { - "system": "urn:ietf:rfc:3986", - "value": "urn:uuid:6ee4a7c0-5911-4c4b-bea2-3c2a1fe5c65f" - }, - "type": "document", - "entry": [ - { - "fullUrl": "Composition/5bd33290-b92e-4aa5-becf-535578207946", - "resource": { - "resourceType": "Composition", - "id": "5bd33290-b92e-4aa5-becf-535578207946", - "status": "final", - "type": { - "coding": [ - { - "system": "http://loinc.org", - "code": "18842-5", - "display": "Discharge summary" - } - ], - "text": "Discharge summary" - }, - "subject": { - "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", - "type": "Patient" - }, - "encounter": { - "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", - "type": "Encounter", - "display": "unknown" - }, - "date": "2022-09-06", - "author": [ - { - "reference": "Practitioner/bba2dee3-2eb3-4973-b4b9-62d498b17046", - "type": "Practitioner", - "display": "Unknown" - } - ], - "title": "Discharge summary", - "section": [ - { - "title": "General", - "code": { - "coding": [ - { - "system": "", - "display": "Unrecognized Section" - } - ], - "text": "General" - }, - "text": { - "status": "additional", - "div": "
\r\n\t\t\t\t\t\t\t

General

\r\n\t\t\t\t\t\t\t

Prescribed 100mg ibuprofen, taken twice daily.

\r\n\t\t\t\t\t
" - }, - "entry": [ - { - "reference": "List/6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", - "type": "List", - "display": "General" - } - ] - } - ] - } - }, - { - "fullUrl": "Practitioner/bba2dee3-2eb3-4973-b4b9-62d498b17046", - "resource": { - "resourceType": "Practitioner", - "id": "bba2dee3-2eb3-4973-b4b9-62d498b17046", - "name": [ - { - "text": "Unknown", - "family": "Unknown" - } - ] - } - }, - { - "fullUrl": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", - "resource": { - "resourceType": "Patient", - "id": "efcccdf7-87f0-4061-b553-09fc11734594", - "gender": "unknown" - } - }, - { - "fullUrl": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", - "resource": { - "resourceType": "Encounter", - "id": "76214457-f94c-4ccf-95ef-ab31e7232d63", - "meta": { - "profile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter" - ] - }, - "status": "finished", - "class": { - "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", - "display": "unknown" - }, - "subject": { - "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", - "type": "Patient" - }, - "period": { - "start": "2022-09-06", - "end": "2022-09-06" - } - } - }, - { - "fullUrl": "MedicationStatement/ac0264b6-63b7-4cf2-a7c3-f7340788aca7", - "resource": { - "resourceType": "MedicationStatement", - "id": "ac0264b6-63b7-4cf2-a7c3-f7340788aca7", - "extension": [ - { - "extension": [ - { - "url": "offset", - "valueInteger": 17 - }, - { - "url": "length", - "valueInteger": 9 - } - ], - "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" - } - ], - "status": "active", - "medicationCodeableConcept": { - "coding": [ - { - "system": "http://www.nlm.nih.gov/research/umls", - "code": "C0020740", - "display": "ibuprofen" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/aod", - "code": "0000019879" - }, - { - "system": "http://www.whocc.no/atc", - "code": "M01AE01" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/ccpss", - "code": "0046165" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/chv", - "code": "0000006519" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/csp", - "code": "2270-2077" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/drugbank", - "code": "DB01050" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/gs", - "code": "1611" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/lch_nw", - "code": "sh97005926" - }, - { - "system": "http://loinc.org", - "code": "LP16165-0" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/medcin", - "code": "40458" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/mmsl", - "code": "d00015" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/msh", - "code": "D007052" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/mthspl", - "code": "WK2XYI10QM" - }, - { - "system": "http://ncimeta.nci.nih.gov", - "code": "C561" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", - "code": "C561" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/nci_dcp", - "code": "00803" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", - "code": "NSC0256857" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/nci_fda", - "code": "WK2XYI10QM" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", - "code": "CDR0000613511" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/nddf", - "code": "002377" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/pdq", - "code": "CDR0000040475" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/rcd", - "code": "x02MO" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/rxnorm", - "code": "5640" - }, - { - "system": "http://snomed.info/sct", - "code": "E-7772" - }, - { - "system": "http://snomed.info/sct", - "code": "C-603C0" - }, - { - "system": "http://snomed.info/sct", - "code": "387207008" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/usp", - "code": "m39860" - }, - { - "system": "http://www.nlm.nih.gov/research/umls/uspmg", - "code": "MTHU000060" - }, - { - "system": "http://hl7.org/fhir/ndfrt", - "code": "4017840" - } - ], - "text": "ibuprofen" - }, - "subject": { - "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", - "type": "Patient" - }, - "context": { - "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", - "type": "Encounter", - "display": "unknown" - }, - "dosage": [ - { - "text": "100mg", - "timing": { - "repeat": { - "frequency": 2, - "period": 1, - "periodUnit": "d" - }, - "code": { - "text": "twice daily" - } - }, - "doseAndRate": [ - { - "doseQuantity": { - "value": 100 - } - } - ] - } - ] - } - }, - { - "fullUrl": "List/6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", - "resource": { - "resourceType": "List", - "id": "6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", - "status": "current", - "mode": "snapshot", - "title": "General", - "subject": { - "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", - "type": "Patient" - }, - "encounter": { - "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", - "type": "Encounter", - "display": "unknown" - }, - "entry": [ - { - "item": { - "reference": "MedicationStatement/ac0264b6-63b7-4cf2-a7c3-f7340788aca7", - "type": "MedicationStatement", - "display": "ibuprofen" - } - } - ] - } - } - ] - } - } - ], - "errors": [], - "modelVersion": "2022-03-01" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulHealthcarePostRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulHealthcarePostRequest.json deleted file mode 100644 index f15eabb7d506..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulHealthcarePostRequest.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "analysisInput": { - "documents": [ - { - "text": "Prescribed 100mg ibuprofen, taken twice daily.", - "id": "1", - "language": "en" - } - ] - }, - "tasks": [ - { - "kind": "Healthcare", - "parameters": { - "modelVersion": "latest" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-04-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulHealthcareTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulHealthcareTaskStatusRequest.json deleted file mode 100644 index 71558dcc43c4..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulHealthcareTaskStatusRequest.json +++ /dev/null @@ -1,220 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-07-20T18:43:35Z", - "displayName": "Extracting Location & US Region", - "expirationDateTime": "2022-07-21T18:43:35Z", - "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0", - "lastUpdatedDateTime": "2022-07-20T18:43:36Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "HealthcareLROResults", - "lastUpdateDateTime": "2022-07-20T18:43:36.7159045Z", - "status": "succeeded", - "results": { - "documents": [ - { - "id": "1", - "entities": [ - { - "offset": 11, - "length": 5, - "text": "100mg", - "category": "Dosage", - "confidenceScore": 0.98 - }, - { - "offset": 17, - "length": 9, - "text": "ibuprofen", - "category": "MedicationName", - "confidenceScore": 1, - "name": "ibuprofen", - "links": [ - { - "dataSource": "UMLS", - "id": "C0020740" - }, - { - "dataSource": "AOD", - "id": "0000019879" - }, - { - "dataSource": "ATC", - "id": "M01AE01" - }, - { - "dataSource": "CCPSS", - "id": "0046165" - }, - { - "dataSource": "CHV", - "id": "0000006519" - }, - { - "dataSource": "CSP", - "id": "2270-2077" - }, - { - "dataSource": "DRUGBANK", - "id": "DB01050" - }, - { - "dataSource": "GS", - "id": "1611" - }, - { - "dataSource": "LCH_NW", - "id": "sh97005926" - }, - { - "dataSource": "LNC", - "id": "LP16165-0" - }, - { - "dataSource": "MEDCIN", - "id": "40458" - }, - { - "dataSource": "MMSL", - "id": "d00015" - }, - { - "dataSource": "MSH", - "id": "D007052" - }, - { - "dataSource": "MTHSPL", - "id": "WK2XYI10QM" - }, - { - "dataSource": "NCI", - "id": "C561" - }, - { - "dataSource": "NCI_CTRP", - "id": "C561" - }, - { - "dataSource": "NCI_DCP", - "id": "00803" - }, - { - "dataSource": "NCI_DTP", - "id": "NSC0256857" - }, - { - "dataSource": "NCI_FDA", - "id": "WK2XYI10QM" - }, - { - "dataSource": "NCI_NCI-GLOSS", - "id": "CDR0000613511" - }, - { - "dataSource": "NDDF", - "id": "002377" - }, - { - "dataSource": "PDQ", - "id": "CDR0000040475" - }, - { - "dataSource": "RCD", - "id": "x02MO" - }, - { - "dataSource": "RXNORM", - "id": "5640" - }, - { - "dataSource": "SNM", - "id": "E-7772" - }, - { - "dataSource": "SNMI", - "id": "C-603C0" - }, - { - "dataSource": "SNOMEDCT_US", - "id": "387207008" - }, - { - "dataSource": "USP", - "id": "m39860" - }, - { - "dataSource": "USPMG", - "id": "MTHU000060" - }, - { - "dataSource": "VANDF", - "id": "4017840" - } - ] - }, - { - "offset": 34, - "length": 11, - "text": "twice daily", - "category": "Frequency", - "confidenceScore": 1 - } - ], - "relations": [ - { - "confidenceScore": 1, - "relationType": "DosageOfMedication", - "entities": [ - { - "ref": "#/results/documents/0/entities/0", - "role": "Dosage" - }, - { - "ref": "#/results/documents/0/entities/1", - "role": "Medication" - } - ] - }, - { - "confidenceScore": 1, - "relationType": "FrequencyOfMedication", - "entities": [ - { - "ref": "#/results/documents/0/entities/1", - "role": "Medication" - }, - { - "ref": "#/results/documents/0/entities/2", - "role": "Frequency" - } - ] - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2022-03-01" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulKeyPhraseExtractionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulKeyPhraseExtractionRequest.json deleted file mode 100644 index 54500d75fa3e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulKeyPhraseExtractionRequest.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "KeyPhraseExtraction", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Microsoft was founded by Bill Gates and Paul Allen." - }, - { - "id": "2", - "language": "en", - "text": "Text Analytics is one of the Azure Cognitive Services." - }, - { - "id": "3", - "language": "en", - "text": "My cat might need to see a veterinarian." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "KeyPhraseExtractionResults", - "results": { - "documents": [ - { - "id": "1", - "keyPhrases": [ - "Bill Gates", - "Paul Allen", - "Microsoft" - ], - "warnings": [] - }, - { - "id": "2", - "keyPhrases": [ - "Azure Cognitive Services", - "Text Analytics" - ], - "warnings": [] - }, - { - "id": "3", - "keyPhrases": [ - "cat", - "veterinarian" - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-06-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulLanguageDetectionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulLanguageDetectionRequest.json deleted file mode 100644 index bd2f71a77554..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulLanguageDetectionRequest.json +++ /dev/null @@ -1,84 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "LanguageDetection", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "text": "Hello world" - }, - { - "id": "2", - "text": "Bonjour tout le monde" - }, - { - "id": "3", - "text": "Hola mundo" - }, - { - "id": "4", - "text": "Tumhara naam kya hai?" - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "LanguageDetectionResults", - "results": { - "documents": [ - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "en", - "name": "English" - }, - "id": "1", - "warnings": [] - }, - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "fr", - "name": "French" - }, - "id": "2", - "warnings": [] - }, - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "es", - "name": "Spanish" - }, - "id": "3", - "warnings": [] - }, - { - "detectedLanguage": { - "confidenceScore": 1, - "iso6391Name": "hi", - "name": "Hindi", - "script": "Latin" - }, - "id": "4", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-01-05" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulPiiEntityRecognitionExclusionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulPiiEntityRecognitionExclusionRequest.json deleted file mode 100644 index 30629a20636b..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulPiiEntityRecognitionExclusionRequest.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "PiiEntityRecognition", - "parameters": { - "modelVersion": "latest", - "excludePiiCategories": [ - "USSocialSecurityNumber" - ] - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "My SSN is 859-98-0987" - }, - { - "id": "2", - "language": "en", - "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." - }, - { - "id": "3", - "language": "en", - "text": "Is 998.214.865-68 your Brazilian CPF number?" - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "PiiEntityRecognitionResults", - "results": { - "documents": [ - { - "id": "2", - "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", - "entities": [ - { - "category": "ABARoutingNumber", - "confidenceScore": 0.75, - "length": 9, - "offset": 18, - "text": "111000025" - } - ], - "warnings": [] - }, - { - "id": "3", - "redactedText": "Is ************** your Brazilian CPF number?", - "entities": [ - { - "category": "BRCPFNumber", - "confidenceScore": 0.85, - "length": 14, - "offset": 3, - "text": "998.214.865-68" - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-01-15" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulPiiEntityRecognitionRedactionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulPiiEntityRecognitionRedactionRequest.json deleted file mode 100644 index a0f020989853..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulPiiEntityRecognitionRedactionRequest.json +++ /dev/null @@ -1,89 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "PiiEntityRecognition", - "parameters": { - "modelVersion": "latest", - "redactionCharacter": "-" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "My SSN is 859-98-0987" - }, - { - "id": "2", - "language": "en", - "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." - }, - { - "id": "3", - "language": "en", - "text": "Is 998.214.865-68 your Brazilian CPF number?" - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "PiiEntityRecognitionResults", - "results": { - "documents": [ - { - "id": "1", - "redactedText": "My SSN is -----------", - "entities": [ - { - "category": "USSocialSecurityNumber", - "confidenceScore": 0.65, - "length": 11, - "offset": 28, - "text": "859-98-0987" - } - ], - "warnings": [] - }, - { - "id": "2", - "redactedText": "Your ABA number - --------- - is the first 9 digits in the lower left hand corner of your personal check.", - "entities": [ - { - "category": "ABARoutingNumber", - "confidenceScore": 0.75, - "length": 9, - "offset": 18, - "text": "111000025" - } - ], - "warnings": [] - }, - { - "id": "3", - "redactedText": "Is -------------- your Brazilian CPF number?", - "entities": [ - { - "category": "BRCPFNumber", - "confidenceScore": 0.85, - "length": 14, - "offset": 3, - "text": "998.214.865-68" - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-01-15" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulPiiEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulPiiEntityRecognitionRequest.json deleted file mode 100644 index 8a0962f985f2..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulPiiEntityRecognitionRequest.json +++ /dev/null @@ -1,88 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "PiiEntityRecognition", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "My SSN is 859-98-0987" - }, - { - "id": "2", - "language": "en", - "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." - }, - { - "id": "3", - "language": "en", - "text": "Is 998.214.865-68 your Brazilian CPF number?" - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "PiiEntityRecognitionResults", - "results": { - "documents": [ - { - "id": "1", - "redactedText": "My SSN is ***********", - "entities": [ - { - "category": "USSocialSecurityNumber", - "confidenceScore": 0.65, - "length": 11, - "offset": 28, - "text": "859-98-0987" - } - ], - "warnings": [] - }, - { - "id": "2", - "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", - "entities": [ - { - "category": "ABARoutingNumber", - "confidenceScore": 0.75, - "length": 9, - "offset": 18, - "text": "111000025" - } - ], - "warnings": [] - }, - { - "id": "3", - "redactedText": "Is ************** your Brazilian CPF number?", - "entities": [ - { - "category": "BRCPFNumber", - "confidenceScore": 0.85, - "length": 14, - "offset": 3, - "text": "998.214.865-68" - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-01-15" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulSentimentAnalysisRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulSentimentAnalysisRequest.json deleted file mode 100644 index ad6ccb5da5b9..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/text/SuccessfulSentimentAnalysisRequest.json +++ /dev/null @@ -1,148 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-15-preview", - "Endpoint": "{Endpoint}", - "body": { - "kind": "SentimentAnalysis", - "parameters": { - "modelVersion": "latest" - }, - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful." - } - ] - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "SentimentAnalysisResults", - "results": { - "documents": [ - { - "confidenceScores": { - "negative": 0, - "neutral": 0, - "positive": 1 - }, - "id": "1", - "sentences": [ - { - "targets": [ - { - "confidenceScores": { - "negative": 0, - "positive": 1 - }, - "length": 10, - "offset": 6, - "relations": [ - { - "ref": "#/documents/0/sentences/0/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "atmosphere" - } - ], - "confidenceScores": { - "negative": 0, - "neutral": 0, - "positive": 1 - }, - "length": 17, - "offset": 0, - "assessments": [ - { - "confidenceScores": { - "negative": 0, - "positive": 1 - }, - "isNegated": false, - "length": 5, - "offset": 0, - "sentiment": "positive", - "text": "great" - } - ], - "sentiment": "positive", - "text": "Great atmosphere." - }, - { - "targets": [ - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "length": 11, - "offset": 37, - "relations": [ - { - "ref": "#/documents/0/sentences/1/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "restaurants" - }, - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "length": 6, - "offset": 50, - "relations": [ - { - "ref": "#/documents/0/sentences/1/assessments/0", - "relationType": "assessment" - } - ], - "sentiment": "positive", - "text": "hotels" - } - ], - "confidenceScores": { - "negative": 0.01, - "neutral": 0.86, - "positive": 0.13 - }, - "length": 52, - "offset": 18, - "assessments": [ - { - "confidenceScores": { - "negative": 0.01, - "positive": 0.99 - }, - "isNegated": false, - "length": 15, - "offset": 18, - "sentiment": "positive", - "text": "Close to plenty" - } - ], - "sentiment": "neutral", - "text": "Close to plenty of restaurants, hotels, and transit!" - } - ], - "sentiment": "positive", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2021-10-01" - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/questionanswering-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/questionanswering-authoring.json deleted file mode 100644 index 54b7e42b2922..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/questionanswering-authoring.json +++ /dev/null @@ -1,1816 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Question Answering - Authoring", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2023-04-15-preview" - }, - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" - } - }, - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://cognitiveservices.azure.com/.default" - ] - }, - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/authoring/query-knowledgebases/projects": { - "get": { - "summary": "Gets all projects for a user.", - "operationId": "QuestionAnsweringProjects_ListProjects", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "The metadata of all projects.", - "schema": { - "$ref": "#/definitions/ProjectsMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectsListProjects.json" - } - } - } - }, - "/authoring/query-knowledgebases/projects/{projectName}": { - "get": { - "summary": "Get the requested project metadata.", - "operationId": "QuestionAnsweringProjects_GetProjectDetails", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The metadata for the specified project.", - "schema": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetProject.json" - } - } - }, - "patch": { - "summary": "Create or update a project.", - "operationId": "QuestionAnsweringProjects_CreateProject", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "description": "Parameters needed to create the project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CreateProjectOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The metadata of the updated project, if it already exists.", - "schema": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "201": { - "description": "The metadata of the created project, if it doesn't exist.", - "schema": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulCreateProject.json" - } - } - }, - "delete": { - "summary": "Delete the project.", - "operationId": "QuestionAnsweringProjects_DeleteProject", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulDeleteProject.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/query-knowledgebases/projects/deletion-jobs/{jobId}": { - "get": { - "summary": "Gets the status of a Project delete job.", - "operationId": "QuestionAnsweringProjects_GetDeleteStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Project delete job status.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json" - } - } - } - }, - "/authoring/query-knowledgebases/projects/{projectName}/:export": { - "post": { - "summary": "Export project metadata and assets.", - "operationId": "QuestionAnsweringProjects_Export", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ImportExportFormatParameter" - }, - { - "$ref": "#/parameters/AssetKindParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Export job status, project metadata, and assets.", - "schema": { - "$ref": "#/definitions/ExportJobState" - } - }, - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/query-knowledgebases/projects/{projectName}/export/jobs/{jobId}": { - "get": { - "summary": "Gets the status of an Export job, once job completes, returns the project metadata, and assets.", - "operationId": "QuestionAnsweringProjects_GetExportStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Export job status, project metadata, and assets.", - "schema": { - "$ref": "#/definitions/ExportJobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json" - } - } - } - }, - "/authoring/query-knowledgebases/projects/{projectName}/:import": { - "post": { - "summary": "Import project assets.", - "operationId": "QuestionAnsweringProjects_Import", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Project assets the needs to be imported.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/ImportJobOptions" - } - }, - { - "$ref": "#/parameters/ImportExportFormatParameter" - }, - { - "$ref": "#/parameters/AssetKindParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/query-knowledgebases/projects/{projectName}/import/jobs/{jobId}": { - "get": { - "summary": "Gets the status of an Import job.", - "operationId": "QuestionAnsweringProjects_GetImportStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Import job status.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json" - } - } - } - }, - "/authoring/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}": { - "put": { - "summary": "Deploy project to production.", - "operationId": "QuestionAnsweringProjects_DeployProject", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { - "get": { - "summary": "Gets the status of a Deploy job.", - "operationId": "QuestionAnsweringProjects_GetDeployStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Deploy job state.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json" - } - } - } - }, - "/authoring/query-knowledgebases/projects/{projectName}/deployments": { - "get": { - "summary": "List all deployments of a project.", - "operationId": "QuestionAnsweringProjects_ListDeployments", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "List of deployments of a project.", - "schema": { - "$ref": "#/definitions/ProjectDeployments" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulProjectListDeployments.json" - } - } - } - }, - "/authoring/query-knowledgebases/projects/{projectName}/synonyms": { - "get": { - "summary": "Gets all the synonyms of a project.", - "operationId": "QuestionAnsweringProjects_GetSynonyms", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "All the synonyms of a project.", - "schema": { - "$ref": "#/definitions/SynonymAssets" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetSynonyms.json" - } - } - }, - "put": { - "summary": "Updates all the synonyms of a project.", - "operationId": "QuestionAnsweringProjects_UpdateSynonyms", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "All the synonyms of a project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SynonymAssets" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "204": { - "description": "Synonyms update successfully." - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json" - } - } - } - }, - "/authoring/query-knowledgebases/projects/{projectName}/sources": { - "get": { - "summary": "Gets all the sources of a project.", - "operationId": "QuestionAnsweringProjects_GetSources", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "All the sources of a project.", - "schema": { - "$ref": "#/definitions/QnaSources" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetSources.json" - } - } - }, - "patch": { - "summary": "Updates the sources of a project.", - "operationId": "QuestionAnsweringProjects_UpdateSources", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Update sources parameters of a project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateSourcesOptions" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSources.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/query-knowledgebases/projects/{projectName}/sources/jobs/{jobId}": { - "get": { - "summary": "Gets the status of update sources job.", - "operationId": "QuestionAnsweringProjects_GetUpdateSourcesStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Update sources job state.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json" - } - } - } - }, - "/authoring/query-knowledgebases/projects/{projectName}/qnas": { - "get": { - "summary": "Gets all the QnAs of a project.", - "operationId": "QuestionAnsweringProjects_GetQnas", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SourceFilterParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" - }, - { - "$ref": "common.json#/parameters/MaxPageSizeParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "responses": { - "200": { - "description": "All the QnAs of a project.", - "schema": { - "$ref": "#/definitions/QnaAssets" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulGetQnas.json" - } - } - }, - "patch": { - "summary": "Updates the QnAs of a project.", - "operationId": "QuestionAnsweringProjects_UpdateQnas", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Update QnAs parameters of a project.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateQnaOptions" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "Operation-Location": { - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateQnas.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/authoring/query-knowledgebases/projects/{projectName}/qnas/jobs/{jobId}": { - "get": { - "summary": "Gets the status of update QnAs job.", - "operationId": "QuestionAnsweringProjects_GetUpdateQnasStatus", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/JobIdParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Update QnAs job state.", - "schema": { - "$ref": "#/definitions/JobState" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json" - } - } - } - }, - "/authoring/query-knowledgebases/projects/{projectName}/feedback": { - "post": { - "summary": "Update Active Learning feedback.", - "operationId": "QuestionAnsweringProjects_AddFeedback", - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "description": "Feedback for Active Learning.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ActiveLearningFeedback" - } - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "204": { - "description": "Feedback recorded successfully." - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json" - } - } - } - } - }, - "definitions": { - "ActiveLearningFeedback": { - "type": "object", - "description": "Feedback for Active Learning.", - "additionalProperties": false, - "properties": { - "records": { - "$ref": "#/definitions/FeedbackRecords" - } - } - }, - "FeedbackRecords": { - "type": "array", - "description": "A list of Feedback Records for Active Learning.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/FeedbackRecord" - } - }, - "FeedbackRecord": { - "type": "object", - "description": "Feedback Record for Active Learning.", - "additionalProperties": false, - "properties": { - "userId": { - "type": "string", - "description": "Unique identifier of the user." - }, - "userQuestion": { - "type": "string", - "description": "User suggested question for the QnA." - }, - "qnaId": { - "type": "integer", - "description": "Unique ID of the QnA.", - "format": "int32" - } - } - }, - "ProjectsMetadata": { - "type": "object", - "description": "Collection of projects metadata and global settings.", - "additionalProperties": false, - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ProjectMetadata" - } - }, - "nextLink": { - "type": "string" - } - } - }, - "ProjectMetadata": { - "type": "object", - "description": "Represents the project.", - "additionalProperties": false, - "properties": { - "projectName": { - "type": "string", - "description": "Name of the project." - }, - "description": { - "type": "string", - "description": "Description of the project." - }, - "language": { - "$ref": "common.json#/definitions/Language" - }, - "multilingualResource": { - "type": "boolean", - "description": "Resource enabled for multiple languages across projects or not." - }, - "settings": { - "$ref": "#/definitions/ProjectSettings" - }, - "createdDateTime": { - "type": "string", - "description": "Project creation date-time.", - "format": "date-time" - }, - "lastModifiedDateTime": { - "type": "string", - "description": "Represents the project last modified date-time.", - "format": "date-time" - }, - "lastDeployedDateTime": { - "type": "string", - "description": "Represents the project last deployment date-time.", - "format": "date-time" - } - } - }, - "CreateProjectOptions": { - "type": "object", - "description": "Parameters needed to create the project.", - "additionalProperties": false, - "required": [ - "language" - ], - "properties": { - "description": { - "type": "string", - "description": "Description of the project." - }, - "language": { - "$ref": "common.json#/definitions/Language" - }, - "multilingualResource": { - "type": "boolean", - "description": "Set to true to enable creating knowledgebases in different languages for the same resource." - }, - "settings": { - "$ref": "#/definitions/ProjectSettings" - } - } - }, - "ProjectSettings": { - "type": "object", - "description": "Configurable settings of the Project.", - "additionalProperties": false, - "properties": { - "defaultAnswer": { - "type": "string", - "description": "Default Answer response when no good match is found in the knowledge base." - } - } - }, - "ImportJobOptions": { - "type": "object", - "description": "Project assets the needs to be imported.", - "additionalProperties": false, - "properties": { - "metadata": { - "$ref": "#/definitions/CreateProjectOptions" - }, - "assets": { - "$ref": "#/definitions/Assets" - }, - "fileUri": { - "type": "string", - "description": "Import data File URI." - } - } - }, - "JobMetadata": { - "description": "Represents the job metadata.", - "properties": { - "createdDateTime": { - "format": "date-time", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "type": "string" - }, - "jobId": { - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { - "$ref": "#/definitions/JobStatus" - } - }, - "required": [ - "jobId", - "lastUpdatedDateTime", - "createdDateTime", - "status" - ], - "type": "object" - }, - "JobStatus": { - "description": "Job Status.", - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling", - "partiallyCompleted" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "jobStatus" - } - }, - "JobState": { - "description": "Job state represents the job metadata and any errors.", - "allOf": [ - { - "$ref": "#/definitions/JobMetadata" - }, - { - "$ref": "#/definitions/Errors" - } - ] - }, - "Errors": { - "description": "Collection of Error types.", - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - } - } - }, - "ExportJobState": { - "description": "Export job status, project metadata, and assets.", - "allOf": [ - { - "$ref": "#/definitions/JobState" - }, - { - "$ref": "#/definitions/ExportJobResultUrl" - } - ] - }, - "ExportJobResultUrl": { - "type": "object", - "description": "URL to download the result of the Export Job.", - "required": [ - "resultUrl" - ], - "properties": { - "resultUrl": { - "type": "string", - "description": "URL to download the result of the Export Job." - } - } - }, - "Assets": { - "type": "object", - "description": "All assets for this project.", - "additionalProperties": false, - "properties": { - "synonyms": { - "$ref": "#/definitions/SynonymAsset" - }, - "qnas": { - "$ref": "#/definitions/ImportQnaAsset" - } - } - }, - "SynonymAssets": { - "type": "object", - "description": "All synonym assets for this project.", - "additionalProperties": false, - "properties": { - "value": { - "$ref": "#/definitions/SynonymAsset" - }, - "nextLink": { - "type": "string" - } - } - }, - "SynonymAsset": { - "type": "array", - "description": "Collection of synonyms.", - "additionalProperties": false, - "maxLength": 10000, - "items": { - "$ref": "#/definitions/WordAlterations" - } - }, - "WordAlterations": { - "type": "object", - "description": "Collection of word alterations.", - "additionalProperties": false, - "required": [ - "alterations" - ], - "properties": { - "alterations": { - "type": "array", - "description": "Collection of word alterations.", - "maxLength": 20, - "items": { - "type": "string" - } - } - } - }, - "QnaAssets": { - "type": "object", - "description": "All QnA assets for the project.", - "additionalProperties": false, - "properties": { - "value": { - "$ref": "#/definitions/QnaAsset" - }, - "nextLink": { - "type": "string" - } - } - }, - "ImportQnaAsset": { - "type": "array", - "description": "List of QnA records to import.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/ImportQnaRecord" - } - }, - "QnaAsset": { - "type": "array", - "description": "List of QnA records.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/RetrieveQnaRecord" - } - }, - "QnaRecord": { - "type": "object", - "description": "QnA record.", - "additionalProperties": false, - "properties": { - "id": { - "type": "integer", - "description": "Unique ID for the QnA.", - "format": "int32" - }, - "answer": { - "type": "string", - "description": "Answer text.", - "maxLength": 25000, - "minLength": 1 - }, - "source": { - "type": "string", - "description": "Source from which QnA was indexed e.g. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .", - "maxLength": 300 - }, - "questions": { - "type": "array", - "description": "List of questions associated with the answer.", - "maxLength": 100, - "minLength": 1, - "items": { - "type": "string" - } - }, - "metadata": { - "type": "object", - "description": "Metadata associated with the answer, useful to categorize or filter question answers.", - "additionalProperties": { - "type": "string" - } - }, - "dialog": { - "description": "Context of a QnA.", - "$ref": "#/definitions/QnaDialog" - }, - "activeLearningSuggestions": { - "type": "array", - "description": "List of Active Learning suggestions for the QnA.", - "items": { - "$ref": "#/definitions/SuggestedQuestionsCluster" - } - } - } - }, - "SuggestedQuestionsCluster": { - "type": "object", - "description": "Active Learning suggested questions cluster details.", - "additionalProperties": false, - "properties": { - "clusterHead": { - "type": "string", - "description": "Question chosen as the head of suggested questions cluster by Active Learning clustering algorithm." - }, - "suggestedQuestions": { - "type": "array", - "description": "List of all suggested questions for the QnA.", - "items": { - "$ref": "#/definitions/SuggestedQuestion" - } - } - } - }, - "SuggestedQuestion": { - "type": "object", - "description": "Question suggested by the Active Learning feature.", - "additionalProperties": false, - "properties": { - "question": { - "type": "string", - "description": "Question suggested by the Active Learning feature." - }, - "userSuggestedCount": { - "type": "integer", - "description": "The number of times the question was suggested explicitly by the user.", - "format": "int32" - }, - "autoSuggestedCount": { - "type": "integer", - "description": "The number of times the question was suggested automatically by the Active Learning algorithm.", - "format": "int32" - } - } - }, - "ImportQnaRecord": { - "description": "Import QnA Record.", - "allOf": [ - { - "$ref": "#/definitions/RetrieveQnaRecord" - }, - { - "$ref": "#/definitions/SourceDisplayNameParameter" - } - ] - }, - "SourceDisplayNameParameter": { - "type": "object", - "properties": { - "sourceDisplayName": { - "description": "Friendly name of the Source.", - "type": "string", - "maxLength": 200, - "minLength": 1 - } - } - }, - "RetrieveQnaRecord": { - "description": "QnA Record with last updated date-time.", - "allOf": [ - { - "$ref": "#/definitions/QnaRecord" - }, - { - "$ref": "#/definitions/LastUpdatedDateTimeParameter" - } - ] - }, - "LastUpdatedDateTimeParameter": { - "type": "object", - "description": "Last updated date-time parameter.", - "properties": { - "lastUpdatedDateTime": { - "type": "string", - "format": "date-time", - "description": "Date-time when the QnA was last updated." - } - } - }, - "QnaDialog": { - "type": "object", - "description": "Dialog associated with QnA Record.", - "properties": { - "isContextOnly": { - "type": "boolean", - "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as answer for queries without context; otherwise, ignores context and includes this QnA in answers." - }, - "prompts": { - "type": "array", - "description": "List of prompts associated with the answer.", - "maxItems": 20, - "items": { - "$ref": "#/definitions/QnaPrompt" - } - } - } - }, - "QnaPrompt": { - "type": "object", - "description": "Prompt for an answer.", - "properties": { - "displayOrder": { - "type": "integer", - "description": "Index of the prompt. It is used for ordering of the prompts.", - "format": "int32" - }, - "qnaId": { - "type": "integer", - "description": "ID of the QnA corresponding to the prompt.", - "format": "int32" - }, - "qna": { - "description": "QnA record. Either QnAId or QnA record needs to be present in a Prompt.", - "$ref": "#/definitions/QnaRecord" - }, - "displayText": { - "type": "string", - "description": "Text displayed to represent a follow up question prompt.", - "maxLength": 200 - } - } - }, - "UpdateOperationKind": { - "type": "string", - "description": "Update operation type for assets.", - "enum": [ - "add", - "delete", - "replace" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "updateOperationKind" - } - }, - "UpdateSourcesOptions": { - "type": "array", - "description": "A list of sources to be updated.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/UpdateSourceRecord" - } - }, - "UpdateQnaOptions": { - "type": "array", - "description": "A list of QnAs to be updated.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/UpdateQnaRecord" - } - }, - "UpdateQnaRecord": { - "type": "object", - "description": "QnA record to be updated.", - "additionalProperties": false, - "required": [ - "op", - "value" - ], - "properties": { - "op": { - "type": "string", - "$ref": "#/definitions/UpdateOperationKind" - }, - "value": { - "$ref": "#/definitions/QnaRecord" - } - } - }, - "UpdateSourceRecord": { - "type": "object", - "description": "Source to be updated.", - "additionalProperties": false, - "required": [ - "op", - "value" - ], - "properties": { - "op": { - "type": "string", - "$ref": "#/definitions/UpdateOperationKind" - }, - "value": { - "$ref": "#/definitions/UpdateQnaSourceRecord" - } - } - }, - "QnaSources": { - "type": "object", - "description": "All QnA sources for the project.", - "additionalProperties": false, - "properties": { - "value": { - "$ref": "#/definitions/QnaSourcesMetadata" - }, - "nextLink": { - "type": "string" - } - } - }, - "QnaSourcesMetadata": { - "type": "array", - "description": "Custom sources from which QnAs were extracted or explicitly added to the project.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/QnaSourceRecord" - } - }, - "QnaSourceRecord": { - "description": "Custom source record with last updated date-time.", - "allOf": [ - { - "$ref": "#/definitions/QnaSourceMetadata" - }, - { - "$ref": "#/definitions/LastUpdatedDateTimeParameter" - } - ] - }, - "UpdateQnaSourceRecord": { - "description": "Update source record.", - "allOf": [ - { - "$ref": "#/definitions/QnaSourceMetadata" - }, - { - "$ref": "#/definitions/RefreshSourceOptions" - } - ] - }, - "RefreshSourceOptions": { - "type": "object", - "description": "Boolean flag used to refresh data from the Source.", - "properties": { - "refresh": { - "type": "boolean", - "description": "Boolean flag used to refresh data from the Source." - } - } - }, - "QnaSourceMetadata": { - "type": "object", - "description": "Input source file or url details.", - "additionalProperties": false, - "required": [ - "sourceUri", - "sourceKind", - "source" - ], - "properties": { - "displayName": { - "type": "string", - "description": "Friendly name of the Source.", - "maxLength": 200, - "minLength": 1 - }, - "source": { - "type": "string", - "description": "Unique source identifier. Name of the file if it's a 'file' source; otherwise, the complete URL if it's a 'url' source." - }, - "sourceUri": { - "type": "string", - "description": "URI location for the file or url.", - "format": "uri" - }, - "sourceKind": { - "type": "string", - "$ref": "#/definitions/QnaSourceKind", - "default": "url" - }, - "contentStructureKind": { - "type": "string", - "$ref": "#/definitions/SourceContentStructureKind", - "default": "Unstructured" - } - } - }, - "QnaSourceKind": { - "type": "string", - "description": "Supported source types.", - "x-ms-enum": { - "name": "sourceKind", - "modelAsString": true - }, - "enum": [ - "file", - "url" - ] - }, - "SourceContentStructureKind": { - "type": "string", - "description": "Content structure type for sources.", - "enum": [ - "unstructured" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "sourceContentStructureKind" - } - }, - "ProjectDeployments": { - "type": "object", - "description": "All deployments of a project.", - "additionalProperties": false, - "properties": { - "value": { - "$ref": "#/definitions/ProjectDeploymentsList" - }, - "nextLink": { - "type": "string" - } - } - }, - "ProjectDeploymentsList": { - "type": "array", - "description": "List of deployments of a project.", - "additionalProperties": false, - "items": { - "$ref": "#/definitions/ProjectDeployment" - } - }, - "ProjectDeployment": { - "type": "object", - "description": "Project deployment details.", - "additionalProperties": false, - "properties": { - "deploymentName": { - "type": "string", - "description": "Name of the deployment." - }, - "lastDeployedDateTime": { - "type": "string", - "description": "Represents the project last deployment date-time.", - "format": "date-time" - } - } - } - }, - "parameters": { - "JobIdParameter": { - "name": "jobId", - "in": "path", - "description": "Job ID.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AssetKindParameter": { - "name": "assetKind", - "type": "string", - "in": "query", - "description": "Kind of the asset of the project.", - "enum": [ - "qnas", - "synonyms" - ], - "x-ms-enum": { - "name": "assetKind", - "modelAsString": true, - "values": [ - { - "value": "qnas" - }, - { - "value": "synonyms" - } - ] - }, - "x-ms-parameter-location": "method" - }, - "ImportExportFormatParameter": { - "name": "format", - "type": "string", - "in": "query", - "description": "Knowledge base Import or Export format.", - "default": "json", - "enum": [ - "json", - "tsv", - "excel" - ], - "x-ms-enum": { - "name": "format", - "modelAsString": true, - "values": [ - { - "value": "json", - "description": "Export or Import QnA assets in JSON format." - }, - { - "value": "tsv", - "description": "Export or Import knowledge base replica including all assets and metadata in Excel format." - }, - { - "value": "excel", - "description": "Export or Import knowledge base replica including all assets and metadata in Tsv format." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "SourceFilterParameter": { - "name": "source", - "in": "query", - "description": "Source of the QnA.", - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/questionanswering.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/questionanswering.json deleted file mode 100644 index ddab62c2819e..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/questionanswering.json +++ /dev/null @@ -1,601 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Question Answering", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", - "version": "2023-04-15-preview" - }, - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" - } - }, - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://cognitiveservices.azure.com/.default" - ] - }, - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "common.json#/parameters/Endpoint" - } - ] - }, - "paths": { - "/:query-knowledgebases": { - "post": { - "summary": "Answers the specified question using your knowledge base.", - "operationId": "QuestionAnswering_GetAnswers", - "parameters": [ - { - "$ref": "#/parameters/AnswersOptions" - }, - { - "$ref": "common.json#/parameters/ProjectNameQueryParameter" - }, - { - "$ref": "common.json#/parameters/DeploymentNameQueryParameter" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "A successful response to get answers from knowledge base.", - "schema": { - "$ref": "#/definitions/AnswersResult" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/SuccessfulQueryKnowledgebases.json" - } - } - } - }, - "/:query-text": { - "post": { - "summary": "Answers the specified question using the provided text in the body.", - "operationId": "QuestionAnswering_GetAnswersFromText", - "parameters": [ - { - "$ref": "#/parameters/AnswersFromTextOptions" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "A successful response to get answers from input text.", - "schema": { - "$ref": "#/definitions/AnswersFromTextResult" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful query": { - "$ref": "./examples/questionanswering/SuccessfulQueryText.json" - } - } - } - } - }, - "definitions": { - "AnswersOptions": { - "type": "object", - "description": "Parameters to query a knowledge base.", - "additionalProperties": false, - "properties": { - "qnaId": { - "type": "integer", - "description": "Exact QnA ID to fetch from the knowledge base, this field takes priority over question.", - "format": "int32" - }, - "question": { - "type": "string", - "description": "User question to query against the knowledge base." - }, - "top": { - "type": "integer", - "description": "Max number of answers to be returned for the question.", - "format": "int32" - }, - "userId": { - "type": "string", - "description": "Unique identifier for the user." - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidenceThreshold", - "description": "Minimum threshold score for answers, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "context": { - "x-ms-client-name": "answerContext", - "description": "Context object with previous QnA's information.", - "$ref": "#/definitions/KnowledgeBaseAnswerContext" - }, - "rankerType": { - "type": "string", - "x-ms-client-name": "rankerKind", - "description": "Type of ranker to be used.", - "x-ms-enum": { - "name": "RankerKind", - "modelAsString": true, - "values": [ - { - "value": "QuestionOnly", - "description": "Question only ranker." - }, - { - "value": "Default", - "description": "Default ranker." - } - ] - }, - "enum": [ - "Default", - "QuestionOnly" - ] - }, - "filters": { - "description": "Filter QnAs based on given metadata list and knowledge base sources.", - "$ref": "#/definitions/QueryFilters" - }, - "answerSpanRequest": { - "x-ms-client-name": "shortAnswerOptions", - "description": "To configure Answer span prediction feature.", - "$ref": "#/definitions/ShortAnswerOptions" - }, - "includeUnstructuredSources": { - "type": "boolean", - "description": "(Optional) Flag to enable Query over Unstructured Sources." - } - } - }, - "ShortAnswerOptions": { - "type": "object", - "description": "To configure Answer span prediction feature.", - "additionalProperties": false, - "required": [ - "enable" - ], - "properties": { - "enable": { - "type": "boolean", - "description": "Enable or disable Answer Span prediction.", - "enum": [ - true - ], - "x-ms-enum": { - "name": "enable", - "modelAsString": false - } - }, - "confidenceScoreThreshold": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidenceThreshold", - "description": "Minimum threshold score required to include an answer span, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "topAnswersWithSpan": { - "type": "integer", - "x-ms-client-name": "top", - "description": "Number of Top answers to be considered for span prediction from 1 to 10.", - "format": "int32", - "maximum": 10, - "minimum": 1 - } - } - }, - "KnowledgeBaseAnswerContext": { - "type": "object", - "description": "Context object with previous QnA's information.", - "additionalProperties": false, - "required": [ - "previousQnaId" - ], - "properties": { - "previousQnaId": { - "type": "integer", - "description": "Previous turn top answer result QnA ID.", - "format": "int32" - }, - "previousUserQuery": { - "type": "string", - "x-ms-client-name": "previousQuestion", - "description": "Previous user query." - } - } - }, - "AnswersResult": { - "type": "object", - "description": "Represents List of Question Answers.", - "additionalProperties": false, - "properties": { - "answers": { - "type": "array", - "description": "Represents Answer Result list.", - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswer" - } - } - } - }, - "KnowledgeBaseAnswer": { - "type": "object", - "description": "Represents knowledge base answer.", - "additionalProperties": false, - "properties": { - "questions": { - "type": "array", - "description": "List of questions associated with the answer.", - "items": { - "type": "string" - } - }, - "answer": { - "type": "string", - "description": "Answer text." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "x-ms-client-name": "confidence", - "description": "Answer confidence score, value ranges from 0 to 1.", - "maximum": 1, - "minimum": 0 - }, - "id": { - "type": "integer", - "x-ms-client-name": "qnaId", - "description": "ID of the QnA result.", - "format": "int32" - }, - "source": { - "type": "string", - "description": "Source of QnA result." - }, - "metadata": { - "type": "object", - "description": "Metadata associated with the answer, useful to categorize or filter question answers.", - "additionalProperties": { - "type": "string" - } - }, - "dialog": { - "type": "object", - "$ref": "#/definitions/KnowledgeBaseAnswerDialog" - }, - "answerSpan": { - "type": "object", - "x-ms-client-name": "shortAnswer", - "description": "Answer span object of QnA with respect to user's question.", - "$ref": "#/definitions/AnswerSpan" - } - } - }, - "KnowledgeBaseAnswerDialog": { - "type": "object", - "description": "Dialog associated with Answer.", - "properties": { - "isContextOnly": { - "type": "boolean", - "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as search result for queries without context; otherwise, if false, ignores context and includes this QnA in search result." - }, - "prompts": { - "type": "array", - "description": "List of prompts associated with the answer.", - "maxItems": 20, - "items": { - "$ref": "#/definitions/KnowledgeBaseAnswerPrompt" - } - } - } - }, - "KnowledgeBaseAnswerPrompt": { - "type": "object", - "description": "Prompt for an answer.", - "properties": { - "displayOrder": { - "type": "integer", - "description": "Index of the prompt - used in ordering of the prompts.", - "format": "int32" - }, - "qnaId": { - "type": "integer", - "description": "QnA ID corresponding to the prompt.", - "format": "int32" - }, - "displayText": { - "type": "string", - "description": "Text displayed to represent a follow up question prompt.", - "maxLength": 200 - } - } - }, - "QueryFilters": { - "type": "object", - "description": "filters over knowledge base.", - "additionalProperties": false, - "properties": { - "metadataFilter": { - "type": "object", - "$ref": "#/definitions/MetadataFilter" - }, - "sourceFilter": { - "type": "object", - "$ref": "#/definitions/SourceFilter" - }, - "logicalOperation": { - "type": "string", - "description": "Logical operation used to join metadata filter with source filter.", - "$ref": "#/definitions/LogicalOperationKind", - "default": "AND" - } - } - }, - "MetadataFilter": { - "type": "object", - "description": "Find QnAs that are associated with the given list of metadata.", - "additionalProperties": false, - "properties": { - "metadata": { - "type": "array", - "items": { - "$ref": "#/definitions/MetadataRecord" - } - }, - "logicalOperation": { - "type": "string", - "description": "Operation used to join metadata filters.", - "$ref": "#/definitions/LogicalOperationKind", - "default": "AND" - } - } - }, - "MetadataRecord": { - "type": "object", - "description": "Object to provide the key value pair for each metadata.", - "additionalProperties": false, - "required": [ - "key", - "value" - ], - "properties": { - "key": { - "type": "string", - "description": "Metadata Key from Metadata dictionary used in the QnA." - }, - "value": { - "type": "string", - "description": "Metadata Value from Metadata dictionary used in the QnA." - } - } - }, - "LogicalOperationKind": { - "type": "string", - "description": "Set to 'OR' or 'AND' for using corresponding logical operation.", - "x-ms-enum": { - "name": "LogicalOperationKind", - "modelAsString": true - }, - "enum": [ - "AND", - "OR" - ] - }, - "SourceFilter": { - "type": "array", - "description": "Find QnAs that are associated with any of the given list of sources in knowledge base.", - "items": { - "type": "string" - } - }, - "AnswerSpan": { - "type": "object", - "description": "Answer span object of QnA.", - "additionalProperties": false, - "properties": { - "text": { - "type": "string", - "description": "Predicted text of answer span." - }, - "confidenceScore": { - "type": "number", - "x-ms-client-name": "confidence", - "description": "Predicted score of answer span, value ranges from 0 to 1.", - "format": "double", - "maximum": 1, - "minimum": 0 - }, - "offset": { - "type": "integer", - "description": "The answer span offset from the start of answer.", - "format": "int32" - }, - "length": { - "type": "integer", - "description": "The length of the answer span.", - "format": "int32" - } - } - }, - "AnswersFromTextOptions": { - "type": "object", - "description": "The question and text record parameters to answer.", - "required": [ - "question", - "records" - ], - "additionalProperties": false, - "properties": { - "question": { - "type": "string", - "description": "User question to query against the given text records." - }, - "records": { - "type": "array", - "x-ms-client-name": "textDocuments", - "description": "Text records to be searched for given question.", - "items": { - "$ref": "#/definitions/TextDocument" - } - }, - "language": { - "$ref": "common.json#/definitions/Language" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - } - }, - "AnswersFromTextResult": { - "type": "object", - "description": "Represents the answer results.", - "additionalProperties": false, - "properties": { - "answers": { - "type": "array", - "description": "Represents the answer results.", - "items": { - "$ref": "#/definitions/TextAnswer" - } - } - } - }, - "TextAnswer": { - "type": "object", - "description": "Represents answer result.", - "additionalProperties": false, - "properties": { - "answer": { - "type": "string", - "description": "Answer." - }, - "confidenceScore": { - "type": "number", - "x-ms-client-name": "confidence", - "description": "answer confidence score, value ranges from 0 to 1.", - "format": "double", - "maximum": 1, - "minimum": 0 - }, - "id": { - "type": "string", - "description": "record ID." - }, - "answerSpan": { - "type": "object", - "x-ms-client-name": "shortAnswer", - "description": "Answer span object with respect to user's question.", - "$ref": "#/definitions/AnswerSpan" - }, - "offset": { - "type": "integer", - "description": "The sentence offset from the start of the document.", - "format": "int32" - }, - "length": { - "type": "integer", - "description": "The length of the sentence.", - "format": "int32" - } - } - }, - "TextDocument": { - "type": "object", - "description": "Represent input text record to be queried.", - "additionalProperties": false, - "required": [ - "id", - "text" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the text record." - }, - "text": { - "type": "string", - "description": "Text contents of the record." - } - } - } - }, - "parameters": { - "AnswersOptions": { - "name": "knowledgeBaseQueryOptions", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AnswersOptions" - }, - "x-nullable": true, - "description": "Post body of the request.", - "x-ms-parameter-location": "method" - }, - "AnswersFromTextOptions": { - "name": "textQueryOptions", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AnswersFromTextOptions" - }, - "x-nullable": true, - "description": "Post body of the request.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/readme.csharp.md b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/readme.csharp.md deleted file mode 100644 index f0c6a178371a..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/readme.csharp.md +++ /dev/null @@ -1,18 +0,0 @@ -# Cognitive Services Language SDK for .NET - -This is the AutoRest configuration file the Cognitive Services Language SDK for .NET. - -> see https://aka.ms/autorest - -## Common C# Settings - -```yaml $(csharp) -csharp: - clear-output-folder: true - license-header: MICROSOFT_MIT_NO_VERSION - -directive: - from: swagger-document - where: $.parameters.Endpoint - transform: $.format = "url" -``` diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/readme.md b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/readme.md deleted file mode 100644 index 3c61b1a3a17d..000000000000 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/readme.md +++ /dev/null @@ -1,84 +0,0 @@ -# Cognitive Services Language SDK - -This is the AutoRest configuration file the Cognitive Services Language SDK. - -> see https://aka.ms/autorest - -## Releases - -The current release of Language is 2023-04-15-preview. - - - -```yaml -tag: release_2023-04-15-preview -add-credentials: true -clear-output-folder: true -openapi-type: data-plane -directive: - - suppress: LongRunningResponseStatusCode - reason: The validation tools do not properly recognize 202 as a supported response code. -``` - -### Release - -``` yaml $(tag) == 'release_2023-04-15-preview' -input-file: - - analyzetext.json - - analyzetext-authoring.json - - analyzeconversations.json - - analyzeconversations-authoring.json - - questionanswering.json - - questionanswering-authoring.json -title: - Microsoft Cognitive Language Service -modelerfour: - lenient-model-deduplication: true -``` - -``` yaml $(tag) == 'release_2022-10-01-preview' -input-file: - - analyzetext.json - - analyzetext-authoring.json - - analyzeconversations.json - - analyzeconversations-authoring.json - - questionanswering.json - - questionanswering-authoring.json -title: - Microsoft Cognitive Language Service -modelerfour: - lenient-model-deduplication: true -``` - -``` yaml $(tag) == 'release_2022-07-01-preview' -input-file: - - analyzetext.json - - analyzetext-authoring.json - - analyzeconversations.json - - analyzeconversations-authoring.json - - questionanswering.json - - questionanswering-authoring.json -title: - Microsoft Cognitive Language Service -modelerfour: - lenient-model-deduplication: true -``` - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-net - - repo: azure-sdk-for-python -``` - -## Suppression - -``` yaml -directive: - - suppress: MISSING_APIS_IN_DEFAULT_TAG - reason: Not every service will ship new versions within the Language pillar. -``` diff --git a/specification/cognitiveservices/data-plane/Language/readme.md b/specification/cognitiveservices/data-plane/Language/readme.md index 0c823ef80cda..301d28296c18 100644 --- a/specification/cognitiveservices/data-plane/Language/readme.md +++ b/specification/cognitiveservices/data-plane/Language/readme.md @@ -119,24 +119,6 @@ modelerfour: lenient-model-deduplication: true ``` -### Release 2023-04-15-preview - -These settings apply only when `--tag=release_2023_04_15_preview` is specified on the command line. - -``` yaml $(tag) == 'release_2023-04-15-preview' -input-file: - - preview/2023-04-15-preview/analyzetext.json - - preview/2023-04-15-preview/analyzetext-authoring.json - - preview/2023-04-15-preview/analyzeconversations.json - - preview/2023-04-15-preview/analyzeconversations-authoring.json - - preview/2023-04-15-preview/questionanswering.json - - preview/2023-04-15-preview/questionanswering-authoring.json -title: - Microsoft Cognitive Language Service -modelerfour: - lenient-model-deduplication: true -``` - ### Release 2023-04-01 These settings apply only when `--tag=release_2023_04_01` is specified on the command line. @@ -156,61 +138,6 @@ modelerfour: ``` -### Release 2022-10-01-preview - -These settings apply only when `--tag=release_2022_10_01_preview` is specified on the command line. - -``` yaml $(tag) == 'release_2022_10_01_preview' -input-file: - - preview/2022-10-01-preview/analyzetext.json - - preview/2022-10-01-preview/analyzetext-authoring.json - - preview/2022-10-01-preview/analyzeconversations.json - - preview/2022-10-01-preview/analyzeconversations-authoring.json - - preview/2022-10-01-preview/questionanswering.json - - preview/2022-10-01-preview/questionanswering-authoring.json -title: - Microsoft Cognitive Language Service -modelerfour: - lenient-model-deduplication: true - -``` - -### Release 2022-07-01-preview - -These settings apply only when `--tag=release_2022_07_01_preview` is specified on the command line. - -``` yaml $(tag) == 'release_2022_07_01_preview' -input-file: - - preview/2022-07-01-preview/analyzetext.json - - preview/2022-07-01-preview/analyzeconversations.json - - preview/2022-07-01-preview/analyzetext-authoring.json - - preview/2022-07-01-preview/analyzeconversations-authoring.json - - preview/2022-07-01-preview/questionanswering.json - - preview/2022-07-01-preview/questionanswering-authoring.json -title: - Microsoft Cognitive Language Service -modelerfour: - lenient-model-deduplication: true - -``` - -### Release 2022-05-15-preview - -These settings apply only when `--tag=release_2022_05_15_preview` is specified on the command line. - -``` yaml $(tag) == 'release_2022_05_15_preview' -input-file: - - preview/2022-05-15-preview/analyzetext.json - - preview/2022-05-15-preview/analyzeconversations.json - - preview/2022-05-15-preview/analyzetext-authoring.json - - preview/2022-05-15-preview/analyzeconversations-authoring.json -title: - Microsoft Cognitive Language Service -modelerfour: - lenient-model-deduplication: true - -``` - ### Release 2022-05-01 These settings apply only when `--tag=release_2022_05_01` is specified on the command line. @@ -227,47 +154,6 @@ modelerfour: lenient-model-deduplication: true ``` -### Release 2022-03-01-preview - -These settings apply only when `--tag=release_2022_03_01_preview` is specified on the command line. - -``` yaml $(tag) == 'release_2022_03_01_preview' -input-file: - - preview/2022-03-01-preview/analyzetext.json - - preview/2022-03-01-preview/analyzeconversations.json -title: - Microsoft Cognitive Language Service -modelerfour: - lenient-model-deduplication: true -``` - -### Release 2022-02-01-preview - -These settings apply only when `--tag=release_2022_02_01_preview` is specified on the command line. - -``` yaml $(tag) == 'release_2022_02_01_preview' -input-file: -- preview/2022-02-01-preview/analyzetext.json -title: - Microsoft Cognitive Language Service -modelerfour: - lenient-model-deduplication: true -``` - -### Release 2021-11-01-preview - -These settings apply only when `--tag=release_2021_11_01_preview` is specified on the command line. - -``` yaml $(tag) == 'release_2021_11_01_preview' -input-file: -- preview/2021-11-01-preview/analyzetext.json -- preview/2021-11-01-preview/analyzeconversations.json -title: - Microsoft Cognitive Language Service -modelerfour: - lenient-model-deduplication: true -``` - ### Release 2021-10-01 These settings apply only when `--tag=release_2021_10_01` is specified on the command line. @@ -282,34 +168,6 @@ modelerfour: lenient-model-deduplication: true ``` -### Release 2021-07-15-preview - -These settings apply only when `--tag=release_2021_07_15_preview` is specified on the command line. - -``` yaml $(tag) == 'release_2021_07_15_preview' -input-file: -- preview/2021-07-15-preview/questionanswering.json -- preview/2021-07-15-preview/questionanswering-authoring.json -title: - Microsoft Cognitive Language Service -modelerfour: - lenient-model-deduplication: true -``` - -### Release 2021-05-01-preview - -These settings apply only when `--tag=release_2021_05_01_preview` is specified on the command line. - -``` yaml $(tag) == 'release_2021_05_01_preview' -input-file: -- preview/2021-05-01-preview/questionanswering.json -- preview/2021-05-01-preview/questionanswering-authoring.json -title: - Microsoft Cognitive Language Service -modelerfour: - lenient-model-deduplication: true -``` - ## Swagger to SDK This section describes what SDK should be generated by the automatic system. diff --git a/specification/maps/data-plane/Weather/stable/1.1/weather.json b/specification/maps/data-plane/Weather/stable/1.1/weather.json index f7286f56d6c6..ffdcb750eb84 100644 --- a/specification/maps/data-plane/Weather/stable/1.1/weather.json +++ b/specification/maps/data-plane/Weather/stable/1.1/weather.json @@ -73,20 +73,20 @@ "in": "query", "type": "string", "enum": [ - "metric", - "imperial" + "imperial", + "metric" ], "x-ms-enum": { "name": "WeatherDataUnit", "modelAsString": true, "values": [ { - "value": "metric", - "description": "Return data in metric units. Some example units of metric system are Celsius and kilometer." + "value": "imperial", + "description": "Return data using imperial units such as Fahrenheit (F) for temperature and mile (mi) for distance." }, { - "value": "imperial", - "description": "Return data in imperial units. Some example units of imperial system are Fahrenheit and mile." + "value": "metric", + "description": "Return data using metric units such as Celsius (C) for temperature and kilometer (km) for distance." } ] }, @@ -104,16 +104,16 @@ "RequiredWeatherBasinId": { "name": "basinId", "type": "string", - "description": "Basin identifier", + "description": "The `basinId` enum categorizes the different ocean basins where tropical storms can originate. Each basin is assigned a unique identifier to help specify the location of the storm's origin.", "required": true, "in": "query", "enum": [ "AL", + "CP", "EP", - "SI", "NI", - "CP", "NP", + "SI", "SP" ], "x-ms-enum": { @@ -122,31 +122,31 @@ "values": [ { "value": "AL", - "description": "Atlantic" + "description": "**The Atlantic Ocean**. Crucial for tracking hurricanes that affect the Americas and the Caribbean. It is one of the most active regions for tropical storms." }, { - "value": "EP", - "description": "Eastern Pacific" + "value": "CP", + "description": "**The Central Pacific Ocean**. This basin is used for storms affecting Hawaii and surrounding areas." }, { - "value": "SI", - "description": "Southwest Indian Ocean" + "value": "EP", + "description": "**The Eastern Pacific Ocean**. This basin tracks storms impacting the western coast of the Americas, including Mexico and Central America. It is adjacent to the Central Pacific basin." }, { "value": "NI", - "description": "North Indian Ocean" + "description": "**The North Indian Ocean**. This basin covers storms impacting South Asia, including countries like India and Bangladesh, which are frequently affected by cyclones." }, { - "value": "CP", - "description": "Central Pacific" + "value": "NP", + "description": "**The Northwest Pacific Ocean**. This basin is important for tracking typhoons that affect East Asia, including countries like China, Japan, and the Philippines. It is the most active tropical storm regions globally." }, { - "value": "NP", - "description": "Northwest Pacific" + "value": "SI", + "description": "**The South Indian Ocean**. This basin, positioned south of the equator, covers cyclones impacting Madagascar, Africa, and surrounding regions." }, { "value": "SP", - "description": "South Pacific" + "description": "**The South Pacific Ocean**. This basin, positioned south of the equator, is relevant for cyclones affecting Australia and the South Pacific islands." } ] }, @@ -155,15 +155,15 @@ "OptionalWeatherBasinId": { "name": "basinId", "type": "string", - "description": "Basin identifier", + "description": "The `basinId` enum categorizes the different ocean basins where tropical storms can originate. Each basin is assigned a unique identifier to help specify the location of the storm's origin.", "in": "query", "enum": [ "AL", + "CP", "EP", - "SI", "NI", - "CP", "NP", + "SI", "SP" ], "x-ms-enum": { @@ -172,31 +172,31 @@ "values": [ { "value": "AL", - "description": "Atlantic" + "description": "**The Atlantic Ocean**. Crucial for tracking hurricanes that affect the Americas and the Caribbean. It is one of the most active regions for tropical storms." }, { - "value": "EP", - "description": "Eastern Pacific" + "value": "CP", + "description": "**The Central Pacific Ocean**. This basin is used for storms affecting Hawaii and surrounding areas." }, { - "value": "SI", - "description": "Southwest Indian Ocean" + "value": "EP", + "description": "**The Eastern Pacific Ocean**. This basin tracks storms impacting the western coast of the Americas, including Mexico and Central America. It is adjacent to the Central Pacific basin." }, { "value": "NI", - "description": "North Indian Ocean" + "description": "**The North Indian Ocean**. This basin covers storms impacting South Asia, including countries like India and Bangladesh, which are frequently affected by cyclones." }, { - "value": "CP", - "description": "Central Pacific" + "value": "NP", + "description": "**The Northwest Pacific Ocean**. This basin is important for tracking typhoons that affect East Asia, including countries like China, Japan, and the Philippines. It is the most active tropical storm regions globally." }, { - "value": "NP", - "description": "Northwest Pacific" + "value": "SI", + "description": "**The South Indian Ocean**. This basin, positioned south of the equator, covers cyclones impacting Madagascar, Africa, and surrounding regions." }, { "value": "SP", - "description": "South Pacific" + "description": "**The South Pacific Ocean**. This basin, positioned south of the equator, is relevant for cyclones affecting Australia and the South Pacific islands." } ] }, @@ -928,7 +928,7 @@ }, { "name": "duration", - "description": "Specifies for how many days from now we would like to know about the air quality. Available values are 1, 2, 3, 4, 5, 6, and 7. Default value is 1.", + "description": "Defines the duration for the air quality forecast, with options ranging from 1 to 7 days. The default duration is 1 day.", "default": 1, "in": "query", "type": "integer", @@ -1026,7 +1026,7 @@ }, { "name": "duration", - "description": "Specifies for how many hours from now we would like to know about the air quality. Available values are 1, 12, 24, 48, 72, 96. Default value is 1 hour.", + "description": "Defines the duration, in hours, for the air quality forecast. Available values are 1, 12, 24, 48, 72, and 96. The default value is 1 hour.", "default": 1, "in": "query", "type": "integer", @@ -1266,7 +1266,7 @@ "IconCode": { "type": "integer", "format": "int32", - "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons) for details.", + "description": "Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL.", "enum": [ 1, 2, @@ -1523,7 +1523,7 @@ "UnitType": { "type": "integer", "format": "int32", - "description": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details.", + "description": "An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).", "enum": [ 0, 1, @@ -1642,12 +1642,12 @@ { "value": 17, "name": "Celsius", - "description": "celsius" + "description": "Celsius" }, { "value": 18, "name": "Fahrenheit", - "description": "fahrenheit" + "description": "Fahrenheit" }, { "value": 19, @@ -1679,25 +1679,17 @@ }, "PrecipitationType": { "type": "string", - "description": "Specifies the type of precipitation (\"Rain\" \"Snow\" \"Ice\" or \"Mix\"). If dbz is zero, precipitationType is not present in the response.", + "description": "Specifies the type of precipitation. Valid values are Rain, Snow, Ice, or Mix. This property is included in the response when dBZ is greater than zero.", "enum": [ - "Rain", - "Snow", "Ice", - "Mix" + "Mix", + "Rain", + "Snow" ], "x-ms-enum": { "name": "PrecipitationType", "modelAsString": true, "values": [ - { - "value": "Rain", - "description": "Rain" - }, - { - "value": "Snow", - "description": "Snow" - }, { "value": "Ice", "description": "Ice" @@ -1705,6 +1697,14 @@ { "value": "Mix", "description": "Mix" + }, + { + "value": "Rain", + "description": "Rain" + }, + { + "value": "Snow", + "description": "Snow" } ] } @@ -1782,7 +1782,7 @@ "HazardIndex": { "type": "integer", "format": "int32", - "description": "A severity/hazard index.\n * `0` - No hazard.\n * `1` - Be informed, be aware.\n * `2` - Pay attention, be prepared.\n * `3` - Take action.\n * `4` - Life threatening, emergency.", + "description": "The aggregated severity/hazard index for each waypoint, which can be used to color-code route segments to indicate driver safety.\n * `0` - No hazard.\n * `1` - Be informed, be aware.\n * `2` - Pay attention, be prepared.\n * `3` - Take action.\n * `4` - Life threatening, emergency.", "enum": [ 0, 1, @@ -2038,15 +2038,15 @@ }, "threshold": { "type": "string", - "description": "Key that specifies the threshold value. Along with precipitationType, can be used to determine the simplifiedColor. If dbz is zero, not present in the response." + "description": "Key that specifies the threshold value. Along with precipitationType, can be used to determine the simplifiedColor. If dBZ is zero, not present in the response." }, "color": { "$ref": "#/definitions/ColorValue", - "description": "The full spectrum color that maps to the dBZ (decibel relative to Z). If dbz is zero, color is not present in the response." + "description": "The full spectrum color that maps to the dBZ (decibel relative to Z). If dBZ is zero, color is not present in the response." }, "simplifiedColor": { "$ref": "#/definitions/ColorValue", - "description": "The band color that maps to the precipitation type and threshold. If dbz is zero, not present in the response." + "description": "The band color that maps to the precipitation type and threshold. If dBZ is zero, not present in the response." }, "precipitationType": { "$ref": "#/definitions/PrecipitationType" @@ -2125,7 +2125,7 @@ "description": "Date and time of the beginning of the forecast quarter displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." }, "quarter": { - "description": "Quarter of the day.", + "description": "Divides the day into four 6-hour quarters. Valid values are 0-3:
  • 0: Morning (7am - 1pm)
  • 1: Afternoon (1pm - 7pm)
  • 2: Evening (7pm - 1am)
  • 3: Overnight (1am - 7am)
", "type": "integer", "format": "int32", "enum": [ @@ -3053,52 +3053,52 @@ }, "LatestStatusKeyword": { "type": "string", - "description": "Keyword for the latest status of the alert.", + "description": "A predefined list of eight keywords used to describe the current status of a severe weather alert.", "enum": [ - "New", - "Extend", "Cancel", + "Continue", "Correct", "Expire", - "Upgrade", - "Continue", - "Update" + "Extend", + "New", + "Update", + "Upgrade" ], "x-ms-enum": { "name": "LatestStatusKeyword", "modelAsString": true, "values": [ { - "value": "New", - "description": "\"New\" - the status of an alert upon initial issuance." - }, - { - "value": "Extend", - "description": "\"Extend\" - the alert has been extended in time, in area, or both since its initial issuance." + "value": "Cancel", + "description": "Indicates that the alert has been canceled before its originally scheduled expiration time." }, { - "value": "Cancel", - "description": "\"Cancel\" - the alert has been canceled prior to its original expiration time." + "value": "Continue", + "description": "Indicates that the alert has been updated since its initial issuance, but no changes were made to `alertDetails`, `startTime`, `endTime`, or `class`." }, { "value": "Correct", - "description": "\"Correct\" - the alert has been modified to correct a previous error." + "description": "Indicates that the alert has been modified to correct a previous error." }, { "value": "Expire", - "description": "\"Expire\" - the alert has expired and is no longer active." + "description": "Indicates that the alert has expired and is no longer active." }, { - "value": "Upgrade", - "description": "\"Upgrade\" - the alert has been upgraded to a higher class or category since its initial issuance." + "value": "Extend", + "description": "Indicates that the alert has been extended in duration, area, or both since its initial issuance." }, { - "value": "Continue", - "description": "\"Continue\" - the alert has been updated since its initial issuance, but no changes were made to `alertDetails`, `startTime`, `endTime`, or `class`." + "value": "New", + "description": "The status of an alert when first issued." }, { "value": "Update", - "description": "\"Update\" - the alert has been updated since its initial issuance." + "description": "Indicates that the alert has been modified since its initial issuance." + }, + { + "value": "Upgrade", + "description": "Indicates that the alert has been elevated to a higher class or category since first issued." } ] } @@ -3214,11 +3214,11 @@ "description": "Basin identifier", "enum": [ "AL", + "CP", "EP", - "SI", "NI", - "CP", "NP", + "SI", "SP" ], "x-ms-enum": { @@ -3227,31 +3227,31 @@ "values": [ { "value": "AL", - "description": "Atlantic" + "description": "**The Atlantic Ocean**. Crucial for tracking hurricanes that affect the Americas and the Caribbean. It is one of the most active regions for tropical storms." }, { - "value": "EP", - "description": "Eastern Pacific" + "value": "CP", + "description": "**The Central Pacific Ocean**. This basin is used for storms affecting Hawaii and surrounding areas." }, { - "value": "SI", - "description": "Southwest Indian Ocean" + "value": "EP", + "description": "**The Eastern Pacific Ocean**. This basin tracks storms impacting the western coast of the Americas, including Mexico and Central America. It is adjacent to the Central Pacific basin." }, { "value": "NI", - "description": "North Indian Ocean" + "description": "**The North Indian Ocean**. This basin covers storms impacting South Asia, including countries like India and Bangladesh, which are frequently affected by cyclones." }, { - "value": "CP", - "description": "Central Pacific" + "value": "NP", + "description": "**The Northwest Pacific Ocean**. This basin is important for tracking typhoons that affect East Asia, including countries like China, Japan, and the Philippines. It is the most active tropical storm regions globally." }, { - "value": "NP", - "description": "Northwest Pacific" + "value": "SI", + "description": "**The South Indian Ocean**. This basin, positioned south of the equator, covers cyclones impacting Madagascar, Africa, and surrounding regions." }, { "value": "SP", - "description": "South Pacific" + "description": "**The South Pacific Ocean**. This basin, positioned south of the equator, is relevant for cyclones affecting Australia and the South Pacific islands." } ] } @@ -3677,7 +3677,7 @@ }, "PollutantType": { "type": "string", - "description": "Type of pollutant. Please note that more may be added at any time.", + "description": "Specifies the six types of pollutants tracked by the Azure Maps Weather service.", "enum": [ "CO", "NO2", @@ -3692,34 +3692,34 @@ "values": [ { "value": "CO", - "description": "Carbon monoxide (\"CO\")" + "description": "Carbon monoxide" }, { "value": "NO2", - "description": "Nitrogen dioxide (\"NO2\")" + "description": "Nitrogen dioxide" }, { "value": "O3", - "description": "Ozone (\"O3\")" + "description": "Ozone" }, { "value": "PM2.5", - "description": "Particulate matter 2.5 (\"PM2.5\")" + "description": "Particulate matter 2.5" }, { "value": "PM10", - "description": "Particulate matter 10 (\"PM10\")" + "description": "Particulate matter 10" }, { "value": "SO2", - "description": "Sulfur dioxide (\"SO2\")" + "description": "Sulfur dioxide" } ] } }, "DominantPollutant": { "type": "string", - "description": "Type of pollutant. Please note that more may be added at any time.", + "description": "Identifies the pollutant with the highest concentration.", "enum": [ "Carbon Monoxide", "Nitrogen Dioxide", @@ -3734,27 +3734,27 @@ "values": [ { "value": "Carbon Monoxide", - "description": "Carbon monoxide (\"CO\")" + "description": "Carbon monoxide (CO) is a colorless, odorless, and tasteless but highly toxic gas produced by the incomplete combustion of carbon-containing fuels. Common sources include vehicle exhaust, gas stoves, furnaces, and wood fires." }, { "value": "Nitrogen Dioxide", - "description": "Nitrogen dioxide (\"NO2\")" + "description": "Nitrogen dioxide (NO2) is a significant atmospheric pollutant. It is regulated and subject to recommended limit guidelines set by the World Health Organization (WHO)." }, { "value": "Ozone", - "description": "Ozone (\"O3\")" + "description": "Ozone (O3) is a key component of photochemical smog, the brown, harmful haze that envelops many large cities, resulting from a photochemical reaction between sunlight and certain specific pollutants." }, { "value": "Particulate Matter 2.5", - "description": "Particulate matter 2.5 (\"PM2.5\")" + "description": "Particulate matter 2.5 (PM2.5) refers to fine particles with diameters that are generally 2.5 micrometers and smaller. These particles are more than 100 times thinner than a human hair and can remain suspended in the air for extended periods" }, { "value": "Particulate Matter 10", - "description": "Particulate matter 10 (\"PM10\")" + "description": "Particulate matter 10 (PM10) refers to particles with diameters that are generally 10 micrometers and smaller. These particles can include dust, pollen, soot, smoke, and liquid droplets." }, { "value": "Sulfur Dioxide", - "description": "Sulfur dioxide (\"SO2\")" + "description": "Sulfur dioxide (SO2) is a heavy, colorless inorganic gas with a pungent, irritating odor. It is mainly produced by burning fossil fuels at power plants and industrial facilities, but it can also be emitted from natural sources such as volcanoes." } ] } diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_CreateOrUpdate.json new file mode 100644 index 000000000000..1cac517c3506 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_CreateOrUpdate.json @@ -0,0 +1,72 @@ +{ + "title": "Approval_CreateOrUpdate", + "operationId": "Approval_CreateOrUpdate", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-06-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "resource": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved" + } + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved" + } + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_Delete.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_Delete.json new file mode 100644 index 000000000000..611df2fd2015 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "Approval_Delete", + "operationId": "Approval_Delete", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_Get.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_Get.json new file mode 100644 index 000000000000..b82d8110850b --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_Get.json @@ -0,0 +1,37 @@ +{ + "title": "Approval_Get", + "operationId": "Approval_Get", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved" + } + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_InitiatorCallback.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_InitiatorCallback.json new file mode 100644 index 000000000000..1a4263e628f5 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_InitiatorCallback.json @@ -0,0 +1,28 @@ +{ + "title": "Approval_InitiatorCallback", + "operationId": "Approval_InitiatorCallback", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "body": { + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approved" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_ListByParent.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_ListByParent.json new file mode 100644 index 000000000000..ccc3fec7cd3c --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_ListByParent.json @@ -0,0 +1,42 @@ +{ + "title": "Approval_ListByParent", + "operationId": "Approval_ListByParent", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved" + } + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_Update.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_Update.json new file mode 100644 index 000000000000..7afa25831ff1 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Approvals_Update.json @@ -0,0 +1,51 @@ +{ + "title": "Approval_Update", + "operationId": "Approval_Update", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-06-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "properties": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved" + } + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_CreateOrUpdate.json new file mode 100644 index 000000000000..e9e453a7e223 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_CreateOrUpdate.json @@ -0,0 +1,101 @@ +{ + "title": "CommunityEndpoints_CreateOrUpdate", + "operationId": "CommunityEndpoints_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "resource": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communties/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_Delete.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_Delete.json new file mode 100644 index 000000000000..bb98bd68dde3 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "CommunityEndpoints_Delete", + "operationId": "CommunityEndpoints_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_Get.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_Get.json new file mode 100644 index 000000000000..a21229f9fd1a --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_Get.json @@ -0,0 +1,46 @@ +{ + "title": "CommunityEndpoints_Get", + "operationId": "CommunityEndpoints_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_ListByCommunityResource.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_ListByCommunityResource.json new file mode 100644 index 000000000000..0958612bc8af --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_ListByCommunityResource.json @@ -0,0 +1,51 @@ +{ + "title": "CommunityEndpoints_ListByCommunityResource", + "operationId": "CommunityEndpoints_ListByCommunityResource", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_ListBySubscription.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_ListBySubscription.json new file mode 100644 index 000000000000..a691f2e19299 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_ListBySubscription.json @@ -0,0 +1,50 @@ +{ + "title": "CommunityEndpoints_ListBySubscription", + "operationId": "CommunityEndpoints_ListBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_Update.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_Update.json new file mode 100644 index 000000000000..51f8bceaea95 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/CommunityEndpoints_Update.json @@ -0,0 +1,70 @@ +{ + "title": "CommunityEndpoints_Update", + "operationId": "CommunityEndpoints_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_CreateOrUpdate.json new file mode 100644 index 000000000000..3325cfa8b3eb --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_CreateOrUpdate.json @@ -0,0 +1,489 @@ +{ + "title": "Community_CreateOrUpdate", + "operationId": "Community_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "resource": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "governedServiceList": [ + { + "id": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "AppService", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "ContainerRegistry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "KeyVault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "MicrosoftSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "ServiceBus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "AzureFirewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "PrivateDNSZones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "DataConnectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_Delete.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_Delete.json new file mode 100644 index 000000000000..5d5d5416861c --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "Community_Delete", + "operationId": "Community_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_Get.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_Get.json new file mode 100644 index 000000000000..018c8a26fb58 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_Get.json @@ -0,0 +1,194 @@ +{ + "title": "Community_Get", + "operationId": "Community_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_ListByResourceGroup.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_ListByResourceGroup.json new file mode 100644 index 000000000000..56ad188c2c05 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_ListByResourceGroup.json @@ -0,0 +1,198 @@ +{ + "title": "Community_ListByResourceGroup", + "operationId": "Community_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_ListBySubscription.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_ListBySubscription.json new file mode 100644 index 000000000000..04eef7441ba6 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_ListBySubscription.json @@ -0,0 +1,197 @@ +{ + "title": "Community_ListBySubscription", + "operationId": "Community_ListBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_PostCheckAddressSpaceAvailability.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_PostCheckAddressSpaceAvailability.json new file mode 100644 index 000000000000..084f1426588d --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_PostCheckAddressSpaceAvailability.json @@ -0,0 +1,33 @@ +{ + "operationId": "Community_CheckAddressSpaceAvailability", + "title": "Community_CheckAddressSpaceAvailability", + "parameters": { + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "checkAddressSpaceAvailabilityRequest": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + } + }, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": true + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_Update.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_Update.json new file mode 100644 index 000000000000..46ddf7c6a9ee --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Community_Update.json @@ -0,0 +1,310 @@ +{ + "title": "Community_Update", + "operationId": "Community_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "dnsServers": [ + "azure.net" + ], + "governedServiceList": [ + { + "id": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "AppService", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "ContainerRegistry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "KeyVault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "MicrosoftSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "ServiceBus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "AzureFirewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "PrivateDNSZones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "DataConnectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_ApprovalDeletionCallback.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_ApprovalDeletionCallback.json new file mode 100644 index 000000000000..278ef0d9a686 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_ApprovalDeletionCallback.json @@ -0,0 +1,27 @@ +{ + "operationId": "EnclaveConnection_ApprovalDeletionCallback", + "title": "EnclaveConnection_ApprovalDeletionCallback", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_CreateOrUpdate.json new file mode 100644 index 000000000000..94258eed37c2 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_CreateOrUpdate.json @@ -0,0 +1,79 @@ +{ + "title": "EnclaveConnection_CreateOrUpdate", + "operationId": "EnclaveConnection_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "resource": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_Delete.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_Delete.json new file mode 100644 index 000000000000..84af8ab84f38 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "EnclaveConnection_Delete", + "operationId": "EnclaveConnection_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_Get.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_Get.json new file mode 100644 index 000000000000..3fa04ce12bf2 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_Get.json @@ -0,0 +1,38 @@ +{ + "title": "EnclaveConnection_Get", + "operationId": "EnclaveConnection_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_ListByResourceGroup.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_ListByResourceGroup.json new file mode 100644 index 000000000000..6e181e4f0e9a --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_ListByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "title": "EnclaveConnection_ListByResourceGroup", + "operationId": "EnclaveConnection_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_ListBySubscription.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_ListBySubscription.json new file mode 100644 index 000000000000..baead581952a --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_ListBySubscription.json @@ -0,0 +1,42 @@ +{ + "title": "EnclaveConnection_ListBySubscription", + "operationId": "EnclaveConnection_ListBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_PostApprovalCallback.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_PostApprovalCallback.json new file mode 100644 index 000000000000..206bb94c0561 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_PostApprovalCallback.json @@ -0,0 +1,29 @@ +{ + "operationId": "EnclaveConnection_ApprovalCallback", + "title": "EnclaveConnection_ApprovalCallback", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "resourceRequestAction": "Create", + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_Update.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_Update.json new file mode 100644 index 000000000000..4ec018978564 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveConnection_Update.json @@ -0,0 +1,52 @@ +{ + "title": "EnclaveConnection_Update", + "operationId": "EnclaveConnection_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "sourceCidr": "10.0.0.0/24" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_CreateOrUpdate.json new file mode 100644 index 000000000000..81a6c1647393 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_CreateOrUpdate.json @@ -0,0 +1,98 @@ +{ + "title": "EnclaveEndpoints_CreateOrUpdate", + "operationId": "EnclaveEndpoints_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "resource": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_Delete.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_Delete.json new file mode 100644 index 000000000000..7113940e5bfc --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "EnclaveEndpoints_Delete", + "operationId": "EnclaveEndpoints_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_Get.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_Get.json new file mode 100644 index 000000000000..4bf0a2d69eb8 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_Get.json @@ -0,0 +1,45 @@ +{ + "title": "EnclaveEndpoints_Get", + "operationId": "EnclaveEndpoints_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint" + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_ListByEnclaveResource.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_ListByEnclaveResource.json new file mode 100644 index 000000000000..ffcf98d6bdf3 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_ListByEnclaveResource.json @@ -0,0 +1,49 @@ +{ + "title": "EnclaveEndpoints_ListByEnclaveResource", + "operationId": "EnclaveEndpoints_ListByEnclaveResource", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_ListBySubscription.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_ListBySubscription.json new file mode 100644 index 000000000000..1bf13598e8f4 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "title": "EnclaveEndpoints_ListBySubscription", + "operationId": "EnclaveEndpoints_ListBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_Update.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_Update.json new file mode 100644 index 000000000000..c6ce3b60dd82 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/EnclaveEndpoints_Update.json @@ -0,0 +1,68 @@ +{ + "title": "EnclaveEndpoints_Update", + "operationId": "EnclaveEndpoints_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Operations_List.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Operations_List.json new file mode 100644 index 000000000000..72de8204210a --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Operations_List.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "kribdpoznbvrjci", + "isDataAction": true, + "display": { + "provider": "usvnnruysydqdpwj", + "resource": "lrdjzltcbeoljosqrw", + "operation": "vdnitexr", + "description": "valid description goes here" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_CreateOrUpdate.json new file mode 100644 index 000000000000..b151e4c32f79 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_CreateOrUpdate.json @@ -0,0 +1,95 @@ +{ + "title": "TransitHub_CreateOrUpdate", + "operationId": "TransitHub_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName", + "resource": { + "properties": { + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + } + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "zwwdhidevngwzo", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_Delete.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_Delete.json new file mode 100644 index 000000000000..cb7056404587 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "TransitHub_Delete", + "operationId": "TransitHub_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_Get.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_Get.json new file mode 100644 index 000000000000..9bf51dd8fded --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_Get.json @@ -0,0 +1,45 @@ +{ + "title": "TransitHub_Get", + "operationId": "TransitHub_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_ListByCommunityResource.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_ListByCommunityResource.json new file mode 100644 index 000000000000..316af739cb68 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_ListByCommunityResource.json @@ -0,0 +1,49 @@ +{ + "title": "TransitHub_ListByCommunityResource", + "operationId": "TransitHub_ListByCommunityResource", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithub", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_ListBySubscription.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_ListBySubscription.json new file mode 100644 index 000000000000..23a168cb6545 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "title": "TransitHub_ListBySubscription", + "operationId": "TransitHub_ListBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_Update.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_Update.json new file mode 100644 index 000000000000..d37792c938c9 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/TransitHub_Update.json @@ -0,0 +1,65 @@ +{ + "title": "TransitHub_Update", + "operationId": "TransitHub_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName", + "location": "westcentralus", + "properties": { + "tags": { + "key4278": "hjoxhwofxcshowbnafdrrzq" + }, + "properties": { + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_CreateOrUpdate.json new file mode 100644 index 000000000000..5ea87437aa5c --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_CreateOrUpdate.json @@ -0,0 +1,190 @@ +{ + "title": "VirtualEnclave_CreateOrUpdate", + "operationId": "VirtualEnclave_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "resource": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "diagnosticDestination": "Both" + }, + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_Delete.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_Delete.json new file mode 100644 index 000000000000..b8b1e797b847 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "VirtualEnclave_Delete", + "operationId": "VirtualEnclave_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_Get.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_Get.json new file mode 100644 index 000000000000..0ce7acdc21e5 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_Get.json @@ -0,0 +1,85 @@ +{ + "title": "VirtualEnclave_Get", + "operationId": "VirtualEnclave_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_ListByResourceGroup.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_ListByResourceGroup.json new file mode 100644 index 000000000000..386cbdbe6616 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_ListByResourceGroup.json @@ -0,0 +1,89 @@ +{ + "title": "VirtualEnclave_ListByResourceGroup", + "operationId": "VirtualEnclave_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_ListBySubscription.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_ListBySubscription.json new file mode 100644 index 000000000000..d0035fc2ac05 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_ListBySubscription.json @@ -0,0 +1,88 @@ +{ + "title": "VirtualEnclave_ListBySubscription", + "operationId": "VirtualEnclave_ListBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_Update.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_Update.json new file mode 100644 index 000000000000..e644bb524861 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/VirtualEnclave_Update.json @@ -0,0 +1,128 @@ +{ + "title": "VirtualEnclave_Update", + "operationId": "VirtualEnclave_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "westcentralus", + "properties": { + "tags": { + "Tag1": "Value1" + }, + "properties": { + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "enclaveDefaultSettings": { + "diagnosticDestination": "Both" + }, + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_CreateOrUpdate.json new file mode 100644 index 000000000000..0a5a0d9aa633 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_CreateOrUpdate.json @@ -0,0 +1,71 @@ +{ + "title": "Workload_CreateOrUpdate", + "operationId": "Workload_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload", + "resource": { + "properties": { + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_Delete.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_Delete.json new file mode 100644 index 000000000000..31d0354f3ba7 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "Workload_Delete", + "operationId": "Workload_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_Get.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_Get.json new file mode 100644 index 000000000000..4ec1e7854f23 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_Get.json @@ -0,0 +1,38 @@ +{ + "title": "Workload_Get", + "operationId": "Workload_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_ListByEnclaveResource.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_ListByEnclaveResource.json new file mode 100644 index 000000000000..1d4f9bc83d45 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_ListByEnclaveResource.json @@ -0,0 +1,42 @@ +{ + "title": "Workload_ListByEnclaveResource", + "operationId": "Workload_ListByEnclaveResource", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_ListBySubscription.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_ListBySubscription.json new file mode 100644 index 000000000000..e3895932704e --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "title": "Workload_ListBySubscription", + "operationId": "Workload_ListBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_Update.json b/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_Update.json new file mode 100644 index 000000000000..2075250e1ef2 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-06-01-preview/Workload_Update.json @@ -0,0 +1,54 @@ +{ + "title": "Workload_Update", + "operationId": "Workload_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload", + "location": "westcentralus", + "properties": { + "tags": { + "key9465": "cylmdprdhhwpcdxpynwostvzytkryj" + }, + "properties": { + "resourceGroupCollection": [ + "g" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_CreateOrUpdate.json new file mode 100644 index 000000000000..62f7acb39c6c --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_CreateOrUpdate.json @@ -0,0 +1,108 @@ +{ + "title": "Approval_CreateOrUpdate", + "operationId": "Approval_CreateOrUpdate", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-12-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "resource": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_Delete.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_Delete.json new file mode 100644 index 000000000000..8d0b4841aab2 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "Approval_Delete", + "operationId": "Approval_Delete", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_Get.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_Get.json new file mode 100644 index 000000000000..3113f3601e33 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_Get.json @@ -0,0 +1,49 @@ +{ + "title": "Approval_Get", + "operationId": "Approval_Get", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_InitiatorCallback.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_InitiatorCallback.json new file mode 100644 index 000000000000..0ecaf5494bda --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_InitiatorCallback.json @@ -0,0 +1,28 @@ +{ + "title": "Approval_InitiatorCallback", + "operationId": "Approval_InitiatorCallback", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "body": { + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approved" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_ListByParent.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_ListByParent.json new file mode 100644 index 000000000000..8d559f5776d8 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_ListByParent.json @@ -0,0 +1,54 @@ +{ + "title": "Approval_ListByParent", + "operationId": "Approval_ListByParent", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_Update.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_Update.json new file mode 100644 index 000000000000..c9c7bded4b5c --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Approvals_Update.json @@ -0,0 +1,75 @@ +{ + "title": "Approval_Update", + "operationId": "Approval_Update", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-12-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "properties": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_ApprovalDeletionCallback.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_ApprovalDeletionCallback.json new file mode 100644 index 000000000000..fa398f9853ef --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_ApprovalDeletionCallback.json @@ -0,0 +1,28 @@ +{ + "operationId": "CommunityEndpoints_ApprovalDeletionCallback", + "title": "CommunityEndpoints_ApprovalDeletionCallback", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_CreateOrUpdate.json new file mode 100644 index 000000000000..20a98ce1c8f1 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_CreateOrUpdate.json @@ -0,0 +1,101 @@ +{ + "title": "CommunityEndpoints_CreateOrUpdate", + "operationId": "CommunityEndpoints_CreateOrUpdate", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "resource": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communties/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_Delete.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_Delete.json new file mode 100644 index 000000000000..264bcf0175dc --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "CommunityEndpoints_Delete", + "operationId": "CommunityEndpoints_Delete", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_Get.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_Get.json new file mode 100644 index 000000000000..bcc51c769d67 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_Get.json @@ -0,0 +1,46 @@ +{ + "title": "CommunityEndpoints_Get", + "operationId": "CommunityEndpoints_Get", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_ListByCommunityResource.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_ListByCommunityResource.json new file mode 100644 index 000000000000..b827d5a8e169 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_ListByCommunityResource.json @@ -0,0 +1,51 @@ +{ + "title": "CommunityEndpoints_ListByCommunityResource", + "operationId": "CommunityEndpoints_ListByCommunityResource", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_ListBySubscription.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_ListBySubscription.json new file mode 100644 index 000000000000..73ec29456211 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_ListBySubscription.json @@ -0,0 +1,50 @@ +{ + "title": "CommunityEndpoints_ListBySubscription", + "operationId": "CommunityEndpoints_ListBySubscription", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_PostApprovalCallback.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_PostApprovalCallback.json new file mode 100644 index 000000000000..c7c35fba91b5 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_PostApprovalCallback.json @@ -0,0 +1,29 @@ +{ + "operationId": "CommunityEndpoints_ApprovalCallback", + "title": "CommunityEndpoints_ApprovalCallback", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_Update.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_Update.json new file mode 100644 index 000000000000..b035aaceec9a --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/CommunityEndpoints_Update.json @@ -0,0 +1,70 @@ +{ + "title": "CommunityEndpoints_Update", + "operationId": "CommunityEndpoints_Update", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_CreateOrUpdate.json new file mode 100644 index 000000000000..f7c4d6f7aeb5 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_CreateOrUpdate.json @@ -0,0 +1,612 @@ +{ + "title": "Community_CreateOrUpdate", + "operationId": "Community_CreateOrUpdate", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "resource": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "governedServiceList": [ + { + "id": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "AppService", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "ContainerRegistry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "KeyVault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "MicrosoftSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "ServiceBus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "AzureFirewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "PrivateDNSZones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "DataConnectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + } + ], + "communityRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "approvalSettings": { + "endpointCreation": "NotRequired", + "endpointUpdate": "Required", + "endpointDeletion": "NotRequired", + "connectionCreation": "Required", + "connectionUpdate": "Required", + "connectionDeletion": "NotRequired", + "enclaveCreation": "NotRequired", + "enclaveDeletion": "NotRequired", + "maintenanceMode": "NotRequired", + "serviceCatalogDeployment": "NotRequired", + "notificationOnApprovalCreation": "NotRequired", + "notificationOnApprovalAction": "NotRequired", + "notificationOnApprovalDeletion": "NotRequired", + "mandatoryApprovers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000" + } + ], + "minimumApproversRequired": 0 + }, + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + } + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + } + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + } + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_Delete.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_Delete.json new file mode 100644 index 000000000000..c01710543bc8 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "Community_Delete", + "operationId": "Community_Delete", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_Get.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_Get.json new file mode 100644 index 000000000000..89216c841dc6 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_Get.json @@ -0,0 +1,228 @@ +{ + "title": "Community_Get", + "operationId": "Community_Get", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + } + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_ListByResourceGroup.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_ListByResourceGroup.json new file mode 100644 index 000000000000..6bff3f7f7ee5 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_ListByResourceGroup.json @@ -0,0 +1,232 @@ +{ + "title": "Community_ListByResourceGroup", + "operationId": "Community_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + } + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_ListBySubscription.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_ListBySubscription.json new file mode 100644 index 000000000000..3cbb49e39f8a --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_ListBySubscription.json @@ -0,0 +1,231 @@ +{ + "title": "Community_ListBySubscription", + "operationId": "Community_ListBySubscription", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + } + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_PostCheckAddressSpaceAvailability.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_PostCheckAddressSpaceAvailability.json new file mode 100644 index 000000000000..1855637bff96 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_PostCheckAddressSpaceAvailability.json @@ -0,0 +1,33 @@ +{ + "operationId": "Community_CheckAddressSpaceAvailability", + "title": "Community_CheckAddressSpaceAvailability", + "parameters": { + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "checkAddressSpaceAvailabilityRequest": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + } + }, + "api-version": "2024-12-01-preview" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": true + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_Update.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_Update.json new file mode 100644 index 000000000000..5a07ba852fe2 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Community_Update.json @@ -0,0 +1,358 @@ +{ + "title": "Community_Update", + "operationId": "Community_Update", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "dnsServers": [ + "azure.net" + ], + "governedServiceList": [ + { + "id": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "AppService", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "ContainerRegistry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "KeyVault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "MicrosoftSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "ServiceBus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "AzureFirewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "PrivateDNSZones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "DataConnectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + } + ], + "communityRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_ApprovalDeletionCallback.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_ApprovalDeletionCallback.json new file mode 100644 index 000000000000..c858a8845ec0 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_ApprovalDeletionCallback.json @@ -0,0 +1,27 @@ +{ + "operationId": "EnclaveConnection_ApprovalDeletionCallback", + "title": "EnclaveConnection_ApprovalDeletionCallback", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_CreateOrUpdate.json new file mode 100644 index 000000000000..87c36c9aac13 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_CreateOrUpdate.json @@ -0,0 +1,79 @@ +{ + "title": "EnclaveConnection_CreateOrUpdate", + "operationId": "EnclaveConnection_CreateOrUpdate", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "resource": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_Delete.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_Delete.json new file mode 100644 index 000000000000..bab672f52509 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "EnclaveConnection_Delete", + "operationId": "EnclaveConnection_Delete", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_Get.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_Get.json new file mode 100644 index 000000000000..203c445fb889 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_Get.json @@ -0,0 +1,38 @@ +{ + "title": "EnclaveConnection_Get", + "operationId": "EnclaveConnection_Get", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_ListByResourceGroup.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_ListByResourceGroup.json new file mode 100644 index 000000000000..8604ecfca65d --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_ListByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "title": "EnclaveConnection_ListByResourceGroup", + "operationId": "EnclaveConnection_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_ListBySubscription.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_ListBySubscription.json new file mode 100644 index 000000000000..170e87db1f8e --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_ListBySubscription.json @@ -0,0 +1,42 @@ +{ + "title": "EnclaveConnection_ListBySubscription", + "operationId": "EnclaveConnection_ListBySubscription", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_PostApprovalCallback.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_PostApprovalCallback.json new file mode 100644 index 000000000000..2b60a2383061 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_PostApprovalCallback.json @@ -0,0 +1,29 @@ +{ + "operationId": "EnclaveConnection_ApprovalCallback", + "title": "EnclaveConnection_ApprovalCallback", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_Update.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_Update.json new file mode 100644 index 000000000000..a58da002e704 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveConnection_Update.json @@ -0,0 +1,52 @@ +{ + "title": "EnclaveConnection_Update", + "operationId": "EnclaveConnection_Update", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "sourceCidr": "10.0.0.0/24" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_ApprovalDeletionCallback.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_ApprovalDeletionCallback.json new file mode 100644 index 000000000000..dd2a57fb4804 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_ApprovalDeletionCallback.json @@ -0,0 +1,28 @@ +{ + "operationId": "EnclaveEndpoints_ApprovalDeletionCallback", + "title": "EnclaveEndpoints_ApprovalDeletionCallback", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_CreateOrUpdate.json new file mode 100644 index 000000000000..344891e840f3 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_CreateOrUpdate.json @@ -0,0 +1,98 @@ +{ + "title": "EnclaveEndpoints_CreateOrUpdate", + "operationId": "EnclaveEndpoints_CreateOrUpdate", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "resource": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_Delete.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_Delete.json new file mode 100644 index 000000000000..3ed62f38ab8b --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "EnclaveEndpoints_Delete", + "operationId": "EnclaveEndpoints_Delete", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_Get.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_Get.json new file mode 100644 index 000000000000..7b2124dcc5f8 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_Get.json @@ -0,0 +1,45 @@ +{ + "title": "EnclaveEndpoints_Get", + "operationId": "EnclaveEndpoints_Get", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint" + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_ListByEnclaveResource.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_ListByEnclaveResource.json new file mode 100644 index 000000000000..f08df0b1416f --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_ListByEnclaveResource.json @@ -0,0 +1,49 @@ +{ + "title": "EnclaveEndpoints_ListByEnclaveResource", + "operationId": "EnclaveEndpoints_ListByEnclaveResource", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_ListBySubscription.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_ListBySubscription.json new file mode 100644 index 000000000000..cfbcc8ae3450 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "title": "EnclaveEndpoints_ListBySubscription", + "operationId": "EnclaveEndpoints_ListBySubscription", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_PostApprovalCallback.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_PostApprovalCallback.json new file mode 100644 index 000000000000..c348942e7450 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_PostApprovalCallback.json @@ -0,0 +1,29 @@ +{ + "operationId": "EnclaveEndpoints_ApprovalCallback", + "title": "EnclaveEndpoints_ApprovalCallback", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_Update.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_Update.json new file mode 100644 index 000000000000..40700272a17a --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/EnclaveEndpoints_Update.json @@ -0,0 +1,68 @@ +{ + "title": "EnclaveEndpoints_Update", + "operationId": "EnclaveEndpoints_Update", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Operations_List.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Operations_List.json new file mode 100644 index 000000000000..d494dc5ec820 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Operations_List.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "kribdpoznbvrjci", + "isDataAction": true, + "display": { + "provider": "usvnnruysydqdpwj", + "resource": "lrdjzltcbeoljosqrw", + "operation": "vdnitexr", + "description": "valid description goes here" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_CreateOrUpdate.json new file mode 100644 index 000000000000..51421c5cfb8e --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_CreateOrUpdate.json @@ -0,0 +1,95 @@ +{ + "title": "TransitHub_CreateOrUpdate", + "operationId": "TransitHub_CreateOrUpdate", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName", + "resource": { + "properties": { + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + } + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "zwwdhidevngwzo", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_Delete.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_Delete.json new file mode 100644 index 000000000000..d75b92834b1a --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "TransitHub_Delete", + "operationId": "TransitHub_Delete", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_Get.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_Get.json new file mode 100644 index 000000000000..84166b8378e9 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_Get.json @@ -0,0 +1,45 @@ +{ + "title": "TransitHub_Get", + "operationId": "TransitHub_Get", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_ListByCommunityResource.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_ListByCommunityResource.json new file mode 100644 index 000000000000..171f9b188efc --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_ListByCommunityResource.json @@ -0,0 +1,49 @@ +{ + "title": "TransitHub_ListByCommunityResource", + "operationId": "TransitHub_ListByCommunityResource", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithub", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_ListBySubscription.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_ListBySubscription.json new file mode 100644 index 000000000000..88b931594a3b --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "title": "TransitHub_ListBySubscription", + "operationId": "TransitHub_ListBySubscription", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_Update.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_Update.json new file mode 100644 index 000000000000..7f7bdf093736 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/TransitHub_Update.json @@ -0,0 +1,65 @@ +{ + "title": "TransitHub_Update", + "operationId": "TransitHub_Update", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName", + "location": "westcentralus", + "properties": { + "tags": { + "key4278": "hjoxhwofxcshowbnafdrrzq" + }, + "properties": { + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_CreateOrUpdate.json new file mode 100644 index 000000000000..0d35fabd2395 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_CreateOrUpdate.json @@ -0,0 +1,322 @@ +{ + "title": "VirtualEnclave_CreateOrUpdate", + "operationId": "VirtualEnclave_CreateOrUpdate", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "resource": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "diagnosticDestination": "Both" + }, + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "id": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "id": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "id": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "id": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "id": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "id": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_Delete.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_Delete.json new file mode 100644 index 000000000000..b5ab6ed0658c --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "VirtualEnclave_Delete", + "operationId": "VirtualEnclave_Delete", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_Get.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_Get.json new file mode 100644 index 000000000000..99f271b3ed7f --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_Get.json @@ -0,0 +1,129 @@ +{ + "title": "VirtualEnclave_Get", + "operationId": "VirtualEnclave_Get", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "id": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "id": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_ListByResourceGroup.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_ListByResourceGroup.json new file mode 100644 index 000000000000..14f20d08e578 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_ListByResourceGroup.json @@ -0,0 +1,133 @@ +{ + "title": "VirtualEnclave_ListByResourceGroup", + "operationId": "VirtualEnclave_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "id": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "id": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_ListBySubscription.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_ListBySubscription.json new file mode 100644 index 000000000000..7fb8d522a3d0 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_ListBySubscription.json @@ -0,0 +1,132 @@ +{ + "title": "VirtualEnclave_ListBySubscription", + "operationId": "VirtualEnclave_ListBySubscription", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "id": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "id": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_PostApprovalCallback.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_PostApprovalCallback.json new file mode 100644 index 000000000000..2237f8ffc0bc --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_PostApprovalCallback.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualEnclave_ApprovalCallback", + "title": "VirtualEnclave_ApprovalCallback", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_PostApprovalDeletionCallback.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_PostApprovalDeletionCallback.json new file mode 100644 index 000000000000..cfa29b89657f --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_PostApprovalDeletionCallback.json @@ -0,0 +1,27 @@ +{ + "operationId": "VirtualEnclave_ApprovalDeletionCallback", + "title": "VirtualEnclave_ApprovalDeletionCallback", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_Update.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_Update.json new file mode 100644 index 000000000000..77752d7175ad --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/VirtualEnclave_Update.json @@ -0,0 +1,216 @@ +{ + "title": "VirtualEnclave_Update", + "operationId": "VirtualEnclave_Update", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "westcentralus", + "properties": { + "tags": { + "Tag1": "Value1" + }, + "properties": { + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "enclaveDefaultSettings": { + "diagnosticDestination": "Both" + }, + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "id": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "id": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "id": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "id": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_CreateOrUpdate.json new file mode 100644 index 000000000000..958d114c8332 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_CreateOrUpdate.json @@ -0,0 +1,71 @@ +{ + "title": "Workload_CreateOrUpdate", + "operationId": "Workload_CreateOrUpdate", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload", + "resource": { + "properties": { + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_Delete.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_Delete.json new file mode 100644 index 000000000000..635ca18032d6 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "Workload_Delete", + "operationId": "Workload_Delete", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_Get.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_Get.json new file mode 100644 index 000000000000..fad104de4185 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_Get.json @@ -0,0 +1,38 @@ +{ + "title": "Workload_Get", + "operationId": "Workload_Get", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_ListByEnclaveResource.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_ListByEnclaveResource.json new file mode 100644 index 000000000000..56759b0e4fa2 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_ListByEnclaveResource.json @@ -0,0 +1,42 @@ +{ + "title": "Workload_ListByEnclaveResource", + "operationId": "Workload_ListByEnclaveResource", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_ListBySubscription.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_ListBySubscription.json new file mode 100644 index 000000000000..2329cd7c0d4c --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "title": "Workload_ListBySubscription", + "operationId": "Workload_ListBySubscription", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_Update.json b/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_Update.json new file mode 100644 index 000000000000..f78c95500f5e --- /dev/null +++ b/specification/mission/Mission.Management/examples/2024-12-01-preview/Workload_Update.json @@ -0,0 +1,54 @@ +{ + "title": "Workload_Update", + "operationId": "Workload_Update", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload", + "location": "westcentralus", + "properties": { + "tags": { + "key9465": "cylmdprdhhwpcdxpynwostvzytkryj" + }, + "properties": { + "resourceGroupCollection": [ + "g" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_CreateOrUpdate.json new file mode 100644 index 000000000000..1702fbcb86c0 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_CreateOrUpdate.json @@ -0,0 +1,108 @@ +{ + "title": "Approval_CreateOrUpdate", + "operationId": "Approval_CreateOrUpdate", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "resource": { + "properties": { + "parentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "grandparentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "parentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "grandparentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "parentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "grandparentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_Delete.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_Delete.json new file mode 100644 index 000000000000..a9c7932ab133 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "Approval_Delete", + "operationId": "Approval_Delete", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_ExecuteApprovalAction.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_ExecuteApprovalAction.json new file mode 100644 index 000000000000..c15d7225c926 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_ExecuteApprovalAction.json @@ -0,0 +1,28 @@ +{ + "title": "Approval_ExecuteApprovalAction", + "operationId": "Approval_ExecuteApprovalAction", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "body": { + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approved" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_Get.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_Get.json new file mode 100644 index 000000000000..7671d4fcaf26 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_Get.json @@ -0,0 +1,49 @@ +{ + "title": "Approval_Get", + "operationId": "Approval_Get", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "parentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "grandparentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_InitiatorCallback.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_InitiatorCallback.json new file mode 100644 index 000000000000..7ff061bd87f9 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_InitiatorCallback.json @@ -0,0 +1,28 @@ +{ + "title": "Approval_InitiatorCallback", + "operationId": "Approval_InitiatorCallback", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "body": { + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approved" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_ListByParent.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_ListByParent.json new file mode 100644 index 000000000000..3731127bccf8 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_ListByParent.json @@ -0,0 +1,54 @@ +{ + "title": "Approval_ListByParent", + "operationId": "Approval_ListByParent", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "parentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "grandparentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_NotifyInitiator.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_NotifyInitiator.json new file mode 100644 index 000000000000..d3d36460b706 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_NotifyInitiator.json @@ -0,0 +1,28 @@ +{ + "title": "Approval_NotifyInitiator", + "operationId": "Approval_NotifyInitiator", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "body": { + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approved" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_Update.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_Update.json new file mode 100644 index 000000000000..f8e351bad5aa --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Approvals_Update.json @@ -0,0 +1,75 @@ +{ + "title": "Approval_Update", + "operationId": "Approval_Update", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "properties": { + "properties": { + "parentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "grandparentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "parentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "grandparentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_ApprovalDeletionCallback.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_ApprovalDeletionCallback.json new file mode 100644 index 000000000000..7f2579f86364 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_ApprovalDeletionCallback.json @@ -0,0 +1,28 @@ +{ + "operationId": "CommunityEndpoints_ApprovalDeletionCallback", + "title": "CommunityEndpoints_ApprovalDeletionCallback", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_CreateOrUpdate.json new file mode 100644 index 000000000000..f23136d9b04c --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_CreateOrUpdate.json @@ -0,0 +1,101 @@ +{ + "title": "CommunityEndpoints_CreateOrUpdate", + "operationId": "CommunityEndpoints_CreateOrUpdate", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "resource": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "ports": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "ports": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communties/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "ports": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_Delete.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_Delete.json new file mode 100644 index 000000000000..9ac8f8bc2efa --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "CommunityEndpoints_Delete", + "operationId": "CommunityEndpoints_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_Get.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_Get.json new file mode 100644 index 000000000000..4b83dff5f614 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_Get.json @@ -0,0 +1,46 @@ +{ + "title": "CommunityEndpoints_Get", + "operationId": "CommunityEndpoints_Get", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "ports": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_HandleApprovalCreation.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_HandleApprovalCreation.json new file mode 100644 index 000000000000..155a47cf5b19 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_HandleApprovalCreation.json @@ -0,0 +1,29 @@ +{ + "operationId": "CommunityEndpoints_HandleApprovalCreation", + "title": "CommunityEndpoints_HandleApprovalCreation", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_HandleApprovalDeletion.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_HandleApprovalDeletion.json new file mode 100644 index 000000000000..375a5696ee50 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_HandleApprovalDeletion.json @@ -0,0 +1,28 @@ +{ + "operationId": "CommunityEndpoints_HandleApprovalDeletion", + "title": "CommunityEndpoints_HandleApprovalDeletion", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_ListByCommunityResource.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_ListByCommunityResource.json new file mode 100644 index 000000000000..51dc1eb1fc53 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_ListByCommunityResource.json @@ -0,0 +1,51 @@ +{ + "title": "CommunityEndpoints_ListByCommunityResource", + "operationId": "CommunityEndpoints_ListByCommunityResource", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "ports": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_ListBySubscription.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_ListBySubscription.json new file mode 100644 index 000000000000..0749671de2ae --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_ListBySubscription.json @@ -0,0 +1,50 @@ +{ + "title": "CommunityEndpoints_ListBySubscription", + "operationId": "CommunityEndpoints_ListBySubscription", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "ports": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_NotifyOnApprovalCreation.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_NotifyOnApprovalCreation.json new file mode 100644 index 000000000000..ee2d7055518b --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_NotifyOnApprovalCreation.json @@ -0,0 +1,29 @@ +{ + "operationId": "CommunityEndpoints_NotifyOnApprovalCreation", + "title": "CommunityEndpoints_NotifyOnApprovalCreation", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_NotifyOnApprovalDeletion.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_NotifyOnApprovalDeletion.json new file mode 100644 index 000000000000..efd72f6f4e76 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_NotifyOnApprovalDeletion.json @@ -0,0 +1,28 @@ +{ + "operationId": "CommunityEndpoints_NotifyOnApprovalDeletion", + "title": "CommunityEndpoints_NotifyOnApprovalDeletion", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_PostApprovalCallback.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_PostApprovalCallback.json new file mode 100644 index 000000000000..7af165926e8d --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_PostApprovalCallback.json @@ -0,0 +1,29 @@ +{ + "operationId": "CommunityEndpoints_ApprovalCallback", + "title": "CommunityEndpoints_ApprovalCallback", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_SubscribeApprovalCreation.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_SubscribeApprovalCreation.json new file mode 100644 index 000000000000..fd3981f4d36d --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_SubscribeApprovalCreation.json @@ -0,0 +1,29 @@ +{ + "operationId": "CommunityEndpoints_SubscribeApprovalCreation", + "title": "CommunityEndpoints_SubscribeApprovalCreation", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_SubscribeApprovalDeletion.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_SubscribeApprovalDeletion.json new file mode 100644 index 000000000000..4b84b5241438 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_SubscribeApprovalDeletion.json @@ -0,0 +1,28 @@ +{ + "operationId": "CommunityEndpoints_SubscribeApprovalDeletion", + "title": "CommunityEndpoints_SubscribeApprovalDeletion", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_Update.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_Update.json new file mode 100644 index 000000000000..32b15252d104 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/CommunityEndpoints_Update.json @@ -0,0 +1,70 @@ +{ + "title": "CommunityEndpoints_Update", + "operationId": "CommunityEndpoints_Update", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "ports": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "ports": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_CreateOrUpdate.json new file mode 100644 index 000000000000..3ea457166f98 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_CreateOrUpdate.json @@ -0,0 +1,613 @@ +{ + "title": "Community_CreateOrUpdate", + "operationId": "Community_CreateOrUpdate", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "resource": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "governedServiceList": [ + { + "serviceId": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "AppService", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "ContainerRegistry", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "KeyVault", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "MicrosoftSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "ServiceBus", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "AzureFirewalls", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "PrivateDNSZones", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "DataConnectors", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + } + ], + "communityRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "approvalSettings": { + "endpointCreation": "NotRequired", + "endpointUpdate": "Required", + "endpointDeletion": "NotRequired", + "connectionCreation": "Required", + "connectionUpdate": "Required", + "connectionDeletion": "NotRequired", + "enclaveCreation": "NotRequired", + "enclaveDeletion": "NotRequired", + "maintenanceMode": "NotRequired", + "serviceCatalogDeployment": "NotRequired", + "notificationOnApprovalCreation": "NotRequired", + "notificationOnApprovalAction": "NotRequired", + "notificationOnApprovalDeletion": "NotRequired", + "mandatoryApprovers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000" + } + ], + "minimumApproversRequired": 0 + }, + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "firewallSku": "Standard" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "governedServiceList": [ + { + "serviceId": "AKS", + "serviceName": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "serviceId": "AppService", + "serviceName": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "serviceId": "ContainerRegistry", + "serviceName": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "serviceId": "CosmosDB", + "serviceName": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "serviceId": "KeyVault", + "serviceName": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "serviceId": "MicrosoftSQL", + "serviceName": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "serviceId": "Monitoring", + "serviceName": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "serviceId": "PostgreSQL", + "serviceName": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "serviceId": "ServiceBus", + "serviceName": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "serviceId": "Storage", + "serviceName": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "serviceId": "AzureFirewalls", + "serviceName": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Insights", + "serviceName": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Logic", + "serviceName": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "PrivateDNSZones", + "serviceName": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "DataConnectors", + "serviceName": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + } + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "governedServiceList": [ + { + "serviceId": "AKS", + "serviceName": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "serviceId": "AppService", + "serviceName": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "serviceId": "ContainerRegistry", + "serviceName": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "serviceId": "CosmosDB", + "serviceName": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "serviceId": "KeyVault", + "serviceName": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "serviceId": "MicrosoftSQL", + "serviceName": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "serviceId": "Monitoring", + "serviceName": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "serviceId": "PostgreSQL", + "serviceName": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "serviceId": "ServiceBus", + "serviceName": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "serviceId": "Storage", + "serviceName": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "serviceId": "AzureFirewalls", + "serviceName": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Insights", + "serviceName": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Logic", + "serviceName": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "PrivateDNSZones", + "serviceName": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "DataConnectors", + "serviceName": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + } + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_Delete.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_Delete.json new file mode 100644 index 000000000000..e13386220130 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "Community_Delete", + "operationId": "Community_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_Get.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_Get.json new file mode 100644 index 000000000000..8516f1251435 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_Get.json @@ -0,0 +1,236 @@ +{ + "title": "Community_Get", + "operationId": "Community_Get", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "managedOnBehalfOfConfiguration": { + "moboBrokerResources": [ + { + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Resources/moboBrokers/bnthrkwfkfeorrzvtdxbfz" + } + ] + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "governedServiceList": [ + { + "serviceId": "AKS", + "serviceName": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "serviceId": "AppService", + "serviceName": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "serviceId": "ContainerRegistry", + "serviceName": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "serviceId": "CosmosDB", + "serviceName": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "serviceId": "KeyVault", + "serviceName": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "serviceId": "MicrosoftSQL", + "serviceName": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "serviceId": "Monitoring", + "serviceName": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "serviceId": "PostgreSQL", + "serviceName": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "serviceId": "ServiceBus", + "serviceName": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "serviceId": "Storage", + "serviceName": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "serviceId": "AzureFirewalls", + "serviceName": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Insights", + "serviceName": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Logic", + "serviceName": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "PrivateDNSZones", + "serviceName": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "DataConnectors", + "serviceName": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "firewallSku": "Standard" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_ListByResourceGroup.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_ListByResourceGroup.json new file mode 100644 index 000000000000..d347bda7c5b6 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_ListByResourceGroup.json @@ -0,0 +1,233 @@ +{ + "title": "Community_ListByResourceGroup", + "operationId": "Community_ListByResourceGroup", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "governedServiceList": [ + { + "serviceId": "AKS", + "serviceName": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "serviceId": "AppService", + "serviceName": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "serviceId": "ContainerRegistry", + "serviceName": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "serviceId": "CosmosDB", + "serviceName": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "serviceId": "KeyVault", + "serviceName": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "serviceId": "MicrosoftSQL", + "serviceName": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "serviceId": "Monitoring", + "serviceName": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "serviceId": "PostgreSQL", + "serviceName": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "serviceId": "ServiceBus", + "serviceName": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "serviceId": "Storage", + "serviceName": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "serviceId": "AzureFirewalls", + "serviceName": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Insights", + "serviceName": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Logic", + "serviceName": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "PrivateDNSZones", + "serviceName": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "DataConnectors", + "serviceName": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "firewallSku": "Standard" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_ListBySubscription.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_ListBySubscription.json new file mode 100644 index 000000000000..029b19a271b4 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_ListBySubscription.json @@ -0,0 +1,232 @@ +{ + "title": "Community_ListBySubscription", + "operationId": "Community_ListBySubscription", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "governedServiceList": [ + { + "serviceId": "AKS", + "serviceName": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "serviceId": "AppService", + "serviceName": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "serviceId": "ContainerRegistry", + "serviceName": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "serviceId": "CosmosDB", + "serviceName": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "serviceId": "KeyVault", + "serviceName": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "serviceId": "MicrosoftSQL", + "serviceName": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "serviceId": "Monitoring", + "serviceName": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "serviceId": "PostgreSQL", + "serviceName": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "serviceId": "ServiceBus", + "serviceName": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "serviceId": "Storage", + "serviceName": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "serviceId": "AzureFirewalls", + "serviceName": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Insights", + "serviceName": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Logic", + "serviceName": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "PrivateDNSZones", + "serviceName": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "DataConnectors", + "serviceName": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "firewallSku": "Standard" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_PostCheckAddressSpaceAvailability.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_PostCheckAddressSpaceAvailability.json new file mode 100644 index 000000000000..631ad19dc6d5 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_PostCheckAddressSpaceAvailability.json @@ -0,0 +1,32 @@ +{ + "operationId": "Community_CheckAddressSpaceAvailability", + "title": "Community_CheckAddressSpaceAvailability", + "parameters": { + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "checkAddressSpaceAvailabilityRequest": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true + } + }, + "api-version": "2025-05-01-preview" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": true + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_Update.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_Update.json new file mode 100644 index 000000000000..d3dc1f69d98b --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Community_Update.json @@ -0,0 +1,358 @@ +{ + "title": "Community_Update", + "operationId": "Community_Update", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "dnsServers": [ + "azure.net" + ], + "governedServiceList": [ + { + "serviceId": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "AppService", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "ContainerRegistry", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "KeyVault", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "MicrosoftSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "ServiceBus", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "AzureFirewalls", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "PrivateDNSZones", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "DataConnectors", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + } + ], + "communityRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "governedServiceList": [ + { + "serviceId": "AKS", + "serviceName": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "serviceId": "AppService", + "serviceName": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "serviceId": "ContainerRegistry", + "serviceName": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "serviceId": "CosmosDB", + "serviceName": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "serviceId": "KeyVault", + "serviceName": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "serviceId": "MicrosoftSQL", + "serviceName": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "serviceId": "Monitoring", + "serviceName": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "serviceId": "PostgreSQL", + "serviceName": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "serviceId": "ServiceBus", + "serviceName": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "serviceId": "Storage", + "serviceName": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "serviceId": "AzureFirewalls", + "serviceName": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Insights", + "serviceName": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Logic", + "serviceName": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "PrivateDNSZones", + "serviceName": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "DataConnectors", + "serviceName": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_ApprovalDeletionCallback.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_ApprovalDeletionCallback.json new file mode 100644 index 000000000000..99d9ef59e651 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_ApprovalDeletionCallback.json @@ -0,0 +1,27 @@ +{ + "operationId": "EnclaveConnection_ApprovalDeletionCallback", + "title": "EnclaveConnection_ApprovalDeletionCallback", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_CreateOrUpdate.json new file mode 100644 index 000000000000..412be8b1325c --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_CreateOrUpdate.json @@ -0,0 +1,79 @@ +{ + "title": "EnclaveConnection_CreateOrUpdate", + "operationId": "EnclaveConnection_CreateOrUpdate", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "resource": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_Delete.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_Delete.json new file mode 100644 index 000000000000..5a5016453bd3 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "EnclaveConnection_Delete", + "operationId": "EnclaveConnection_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_Get.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_Get.json new file mode 100644 index 000000000000..a74c4d9dbd25 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_Get.json @@ -0,0 +1,38 @@ +{ + "title": "EnclaveConnection_Get", + "operationId": "EnclaveConnection_Get", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_HandleApprovalCreation.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_HandleApprovalCreation.json new file mode 100644 index 000000000000..999f24d0bbab --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_HandleApprovalCreation.json @@ -0,0 +1,29 @@ +{ + "operationId": "EnclaveConnection_HandleApprovalCreation", + "title": "EnclaveConnection_HandleApprovalCreation", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_HandleApprovalDeletion.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_HandleApprovalDeletion.json new file mode 100644 index 000000000000..e35266d7164e --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_HandleApprovalDeletion.json @@ -0,0 +1,27 @@ +{ + "operationId": "EnclaveConnection_HandleApprovalDeletion", + "title": "EnclaveConnection_HandleApprovalDeletion", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_ListByResourceGroup.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_ListByResourceGroup.json new file mode 100644 index 000000000000..95b5e5871696 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_ListByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "title": "EnclaveConnection_ListByResourceGroup", + "operationId": "EnclaveConnection_ListByResourceGroup", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_ListBySubscription.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_ListBySubscription.json new file mode 100644 index 000000000000..8c13c3e5dde0 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_ListBySubscription.json @@ -0,0 +1,42 @@ +{ + "title": "EnclaveConnection_ListBySubscription", + "operationId": "EnclaveConnection_ListBySubscription", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_NotifyOnApprovalCreation.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_NotifyOnApprovalCreation.json new file mode 100644 index 000000000000..896337acf65d --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_NotifyOnApprovalCreation.json @@ -0,0 +1,29 @@ +{ + "operationId": "EnclaveConnection_NotifyOnApprovalCreation", + "title": "EnclaveConnection_NotifyOnApprovalCreation", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_NotifyOnApprovalDeletion.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_NotifyOnApprovalDeletion.json new file mode 100644 index 000000000000..c17ee22a704e --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_NotifyOnApprovalDeletion.json @@ -0,0 +1,27 @@ +{ + "operationId": "EnclaveConnection_NotifyOnApprovalDeletion", + "title": "EnclaveConnection_NotifyOnApprovalDeletion", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_PostApprovalCallback.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_PostApprovalCallback.json new file mode 100644 index 000000000000..b4c823cf82a0 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_PostApprovalCallback.json @@ -0,0 +1,29 @@ +{ + "operationId": "EnclaveConnection_ApprovalCallback", + "title": "EnclaveConnection_ApprovalCallback", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_SubscribeApprovalCreation.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_SubscribeApprovalCreation.json new file mode 100644 index 000000000000..c504a59d5df4 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_SubscribeApprovalCreation.json @@ -0,0 +1,29 @@ +{ + "operationId": "EnclaveConnection_SubscribeApprovalCreation", + "title": "EnclaveConnection_SubscribeApprovalCreation", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_SubscribeApprovalDeletion.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_SubscribeApprovalDeletion.json new file mode 100644 index 000000000000..d88610244df7 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_SubscribeApprovalDeletion.json @@ -0,0 +1,27 @@ +{ + "operationId": "EnclaveConnection_SubscribeApprovalDeletion", + "title": "EnclaveConnection_SubscribeApprovalDeletion", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_Update.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_Update.json new file mode 100644 index 000000000000..2b57864d6245 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveConnection_Update.json @@ -0,0 +1,52 @@ +{ + "title": "EnclaveConnection_Update", + "operationId": "EnclaveConnection_Update", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "sourceCidr": "10.0.0.0/24" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_ApprovalDeletionCallback.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_ApprovalDeletionCallback.json new file mode 100644 index 000000000000..c7e778fa0055 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_ApprovalDeletionCallback.json @@ -0,0 +1,28 @@ +{ + "operationId": "EnclaveEndpoints_ApprovalDeletionCallback", + "title": "EnclaveEndpoints_ApprovalDeletionCallback", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_CreateOrUpdate.json new file mode 100644 index 000000000000..4e149d60df2b --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_CreateOrUpdate.json @@ -0,0 +1,98 @@ +{ + "title": "EnclaveEndpoints_CreateOrUpdate", + "operationId": "EnclaveEndpoints_CreateOrUpdate", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "resource": { + "properties": { + "ruleCollection": [ + { + "endpointRuleName": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "ports": "443", + "protocols": [ + "TCP" + ] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "endpointRuleName": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "ports": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "ruleCollection": [ + { + "endpointRuleName": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "ports": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_Delete.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_Delete.json new file mode 100644 index 000000000000..377e34864838 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "EnclaveEndpoints_Delete", + "operationId": "EnclaveEndpoints_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_Get.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_Get.json new file mode 100644 index 000000000000..5145968a4a03 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_Get.json @@ -0,0 +1,45 @@ +{ + "title": "EnclaveEndpoints_Get", + "operationId": "EnclaveEndpoints_Get", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint" + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "endpointRuleName": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "ports": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_HandleApprovalCreation.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_HandleApprovalCreation.json new file mode 100644 index 000000000000..28b0bde02d9d --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_HandleApprovalCreation.json @@ -0,0 +1,29 @@ +{ + "operationId": "EnclaveEndpoints_HandleApprovalCreation", + "title": "EnclaveEndpoints_HandleApprovalCreation", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_HandleApprovalDeletion.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_HandleApprovalDeletion.json new file mode 100644 index 000000000000..91e93563ca47 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_HandleApprovalDeletion.json @@ -0,0 +1,28 @@ +{ + "operationId": "EnclaveEndpoints_HandleApprovalDeletion", + "title": "EnclaveEndpoints_HandleApprovalDeletion", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_ListByEnclaveResource.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_ListByEnclaveResource.json new file mode 100644 index 000000000000..b87b85c3241f --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_ListByEnclaveResource.json @@ -0,0 +1,49 @@ +{ + "title": "EnclaveEndpoints_ListByEnclaveResource", + "operationId": "EnclaveEndpoints_ListByEnclaveResource", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "endpointRuleName": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "ports": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_ListBySubscription.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_ListBySubscription.json new file mode 100644 index 000000000000..1e21c255c11f --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "title": "EnclaveEndpoints_ListBySubscription", + "operationId": "EnclaveEndpoints_ListBySubscription", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "endpointRuleName": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "ports": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_NotifyOnApprovalCreation.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_NotifyOnApprovalCreation.json new file mode 100644 index 000000000000..e055ef838e62 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_NotifyOnApprovalCreation.json @@ -0,0 +1,29 @@ +{ + "operationId": "EnclaveEndpoints_NotifyOnApprovalCreation", + "title": "EnclaveEndpoints_NotifyOnApprovalCreation", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_NotifyOnApprovalDeletion.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_NotifyOnApprovalDeletion.json new file mode 100644 index 000000000000..7ac44797e9bf --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_NotifyOnApprovalDeletion.json @@ -0,0 +1,28 @@ +{ + "operationId": "EnclaveEndpoints_NotifyOnApprovalDeletion", + "title": "EnclaveEndpoints_NotifyOnApprovalDeletion", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_PostApprovalCallback.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_PostApprovalCallback.json new file mode 100644 index 000000000000..bde519ac9b82 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_PostApprovalCallback.json @@ -0,0 +1,29 @@ +{ + "operationId": "EnclaveEndpoints_ApprovalCallback", + "title": "EnclaveEndpoints_ApprovalCallback", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_SubscribeApprovalCreation.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_SubscribeApprovalCreation.json new file mode 100644 index 000000000000..98c54e19de7f --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_SubscribeApprovalCreation.json @@ -0,0 +1,29 @@ +{ + "operationId": "EnclaveEndpoints_SubscribeApprovalCreation", + "title": "EnclaveEndpoints_SubscribeApprovalCreation", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_SubscribeApprovalDeletion.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_SubscribeApprovalDeletion.json new file mode 100644 index 000000000000..5011852a4dfa --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_SubscribeApprovalDeletion.json @@ -0,0 +1,28 @@ +{ + "operationId": "EnclaveEndpoints_SubscribeApprovalDeletion", + "title": "EnclaveEndpoints_SubscribeApprovalDeletion", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_Update.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_Update.json new file mode 100644 index 000000000000..00af3b9261d1 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/EnclaveEndpoints_Update.json @@ -0,0 +1,68 @@ +{ + "title": "EnclaveEndpoints_Update", + "operationId": "EnclaveEndpoints_Update", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "ruleCollection": [ + { + "endpointRuleName": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "ports": "443", + "protocols": [ + "TCP" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "endpointRuleName": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "ports": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Operations_List.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Operations_List.json new file mode 100644 index 000000000000..c393ee7b2148 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Operations_List.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2025-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "kribdpoznbvrjci", + "isDataAction": true, + "display": { + "provider": "usvnnruysydqdpwj", + "resource": "lrdjzltcbeoljosqrw", + "operation": "vdnitexr", + "description": "valid description goes here" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_CreateOrUpdate.json new file mode 100644 index 000000000000..0cf707c42dff --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_CreateOrUpdate.json @@ -0,0 +1,95 @@ +{ + "title": "TransitHub_CreateOrUpdate", + "operationId": "TransitHub_CreateOrUpdate", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName", + "resource": { + "properties": { + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + } + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "zwwdhidevngwzo", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_Delete.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_Delete.json new file mode 100644 index 000000000000..c341fc33825b --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "TransitHub_Delete", + "operationId": "TransitHub_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_Get.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_Get.json new file mode 100644 index 000000000000..6ef54f041dc8 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_Get.json @@ -0,0 +1,45 @@ +{ + "title": "TransitHub_Get", + "operationId": "TransitHub_Get", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_ListByCommunityResource.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_ListByCommunityResource.json new file mode 100644 index 000000000000..f32c8c97ef9c --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_ListByCommunityResource.json @@ -0,0 +1,49 @@ +{ + "title": "TransitHub_ListByCommunityResource", + "operationId": "TransitHub_ListByCommunityResource", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithub", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_ListBySubscription.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_ListBySubscription.json new file mode 100644 index 000000000000..ab6b7cb7d621 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "title": "TransitHub_ListBySubscription", + "operationId": "TransitHub_ListBySubscription", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_Update.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_Update.json new file mode 100644 index 000000000000..f4ae5d09155d --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/TransitHub_Update.json @@ -0,0 +1,65 @@ +{ + "title": "TransitHub_Update", + "operationId": "TransitHub_Update", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName", + "location": "westcentralus", + "properties": { + "tags": { + "key4278": "hjoxhwofxcshowbnafdrrzq" + }, + "properties": { + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_CreateOrUpdate.json new file mode 100644 index 000000000000..1e90860e1a5e --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_CreateOrUpdate.json @@ -0,0 +1,319 @@ +{ + "title": "VirtualEnclave_CreateOrUpdate", + "operationId": "VirtualEnclave_CreateOrUpdate", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "resource": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "diagnosticDestination": "Both" + }, + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "roleDefinitionId": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "roleDefinitionId": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "roleDefinitionId": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "roleDefinitionId": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "roleDefinitionId": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "roleDefinitionId": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_Delete.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_Delete.json new file mode 100644 index 000000000000..e42f4937e9e9 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "VirtualEnclave_Delete", + "operationId": "VirtualEnclave_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_Get.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_Get.json new file mode 100644 index 000000000000..a92b51d65224 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_Get.json @@ -0,0 +1,135 @@ +{ + "title": "VirtualEnclave_Get", + "operationId": "VirtualEnclave_Get", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "subnetResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true + }, + "managedOnBehalfOfConfiguration": { + "moboBrokerResources": [ + { + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Resources/moboBrokers/bnthrkwfkfeorrzvtdxbfz" + } + ] + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "roleDefinitionId": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "roleDefinitionId": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_HandleApprovalCreation.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_HandleApprovalCreation.json new file mode 100644 index 000000000000..a6c2b68c3e93 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_HandleApprovalCreation.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualEnclave_HandleApprovalCreation", + "title": "VirtualEnclave_HandleApprovalCreation", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_HandleApprovalDeletion.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_HandleApprovalDeletion.json new file mode 100644 index 000000000000..00339b028b6f --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_HandleApprovalDeletion.json @@ -0,0 +1,27 @@ +{ + "operationId": "VirtualEnclave_HandleApprovalDeletion", + "title": "VirtualEnclave_HandleApprovalDeletion", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_ListByResourceGroup.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_ListByResourceGroup.json new file mode 100644 index 000000000000..0dd4e5d4668d --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_ListByResourceGroup.json @@ -0,0 +1,132 @@ +{ + "title": "VirtualEnclave_ListByResourceGroup", + "operationId": "VirtualEnclave_ListByResourceGroup", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "subnetResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "roleDefinitionId": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "roleDefinitionId": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_ListBySubscription.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_ListBySubscription.json new file mode 100644 index 000000000000..5f87a97bc6bd --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_ListBySubscription.json @@ -0,0 +1,131 @@ +{ + "title": "VirtualEnclave_ListBySubscription", + "operationId": "VirtualEnclave_ListBySubscription", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "subnetResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "roleDefinitionId": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "roleDefinitionId": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_NotifyOnApprovalCreation.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_NotifyOnApprovalCreation.json new file mode 100644 index 000000000000..e04dab1fd8d8 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_NotifyOnApprovalCreation.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualEnclave_NotifyOnApprovalCreation", + "title": "VirtualEnclave_NotifyOnApprovalCreation", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_NotifyOnApprovalDeletion.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_NotifyOnApprovalDeletion.json new file mode 100644 index 000000000000..bec71422a03a --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_NotifyOnApprovalDeletion.json @@ -0,0 +1,27 @@ +{ + "operationId": "VirtualEnclave_NotifyOnApprovalDeletion", + "title": "VirtualEnclave_NotifyOnApprovalDeletion", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_PostApprovalCallback.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_PostApprovalCallback.json new file mode 100644 index 000000000000..115d8fca7835 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_PostApprovalCallback.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualEnclave_ApprovalCallback", + "title": "VirtualEnclave_ApprovalCallback", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_PostApprovalDeletionCallback.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_PostApprovalDeletionCallback.json new file mode 100644 index 000000000000..c658b8e96a77 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_PostApprovalDeletionCallback.json @@ -0,0 +1,27 @@ +{ + "operationId": "VirtualEnclave_ApprovalDeletionCallback", + "title": "VirtualEnclave_ApprovalDeletionCallback", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_SubscribeApprovalCreation.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_SubscribeApprovalCreation.json new file mode 100644 index 000000000000..351cf984299a --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_SubscribeApprovalCreation.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualEnclave_SubscribeApprovalCreation", + "title": "VirtualEnclave_SubscribeApprovalCreation", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_SubscribeApprovalDeletion.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_SubscribeApprovalDeletion.json new file mode 100644 index 000000000000..fd46143f643b --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_SubscribeApprovalDeletion.json @@ -0,0 +1,27 @@ +{ + "operationId": "VirtualEnclave_SubscribeApprovalDeletion", + "title": "VirtualEnclave_SubscribeApprovalDeletion", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_Update.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_Update.json new file mode 100644 index 000000000000..46b15bbf5498 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/VirtualEnclave_Update.json @@ -0,0 +1,214 @@ +{ + "title": "VirtualEnclave_Update", + "operationId": "VirtualEnclave_Update", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "westcentralus", + "properties": { + "tags": { + "Tag1": "Value1" + }, + "properties": { + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true + }, + "enclaveDefaultSettings": { + "diagnosticDestination": "Both" + }, + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "roleDefinitionId": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "roleDefinitionId": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "roleDefinitionId": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "roleDefinitionId": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_CreateOrUpdate.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_CreateOrUpdate.json new file mode 100644 index 000000000000..6f0ac2af23e6 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_CreateOrUpdate.json @@ -0,0 +1,71 @@ +{ + "title": "Workload_CreateOrUpdate", + "operationId": "Workload_CreateOrUpdate", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload", + "resource": { + "properties": { + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_Delete.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_Delete.json new file mode 100644 index 000000000000..dc54a34b75e2 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "Workload_Delete", + "operationId": "Workload_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_Get.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_Get.json new file mode 100644 index 000000000000..00425fbfb254 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_Get.json @@ -0,0 +1,45 @@ +{ + "title": "Workload_Get", + "operationId": "Workload_Get", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ], + "managedOnBehalfOfConfiguration": { + "moboBrokerResources": [ + { + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Resources/moboBrokers/bnthrkwfkfeorrzvtdxbfz" + } + ] + } + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_ListByEnclaveResource.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_ListByEnclaveResource.json new file mode 100644 index 000000000000..5dc42879932f --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_ListByEnclaveResource.json @@ -0,0 +1,42 @@ +{ + "title": "Workload_ListByEnclaveResource", + "operationId": "Workload_ListByEnclaveResource", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_ListBySubscription.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_ListBySubscription.json new file mode 100644 index 000000000000..c477c14af071 --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "title": "Workload_ListBySubscription", + "operationId": "Workload_ListBySubscription", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_Update.json b/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_Update.json new file mode 100644 index 000000000000..22e96a7e53dc --- /dev/null +++ b/specification/mission/Mission.Management/examples/2025-05-01-preview/Workload_Update.json @@ -0,0 +1,54 @@ +{ + "title": "Workload_Update", + "operationId": "Workload_Update", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload", + "location": "westcentralus", + "properties": { + "tags": { + "key9465": "cylmdprdhhwpcdxpynwostvzytkryj" + }, + "properties": { + "resourceGroupCollection": [ + "g" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/Mission.Management/main.tsp b/specification/mission/Mission.Management/main.tsp new file mode 100644 index 000000000000..27d5aa86dee8 --- /dev/null +++ b/specification/mission/Mission.Management/main.tsp @@ -0,0 +1,21 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/openapi"; +import "@typespec/versioning"; +import "@azure-tools/typespec-autorest"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +import "./version.tsp"; +import "./routes.tsp"; + +using Azure.ResourceManager; +using TypeSpec.Versioning; + +@armProviderNamespace("Microsoft.Mission") +@service(#{ title: "Microsoft.Mission" }) +@versioned(Microsoft.Mission.Versions) +@doc("Microsoft.Mission Resource Provider management API.") +namespace Microsoft.Mission; + +interface Operations extends Azure.ResourceManager.Operations {} diff --git a/specification/mission/Mission.Management/model.tsp b/specification/mission/Mission.Management/model.tsp new file mode 100644 index 000000000000..5c6b45733b88 --- /dev/null +++ b/specification/mission/Mission.Management/model.tsp @@ -0,0 +1,140 @@ +import "@azure-tools/typespec-autorest"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/http"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "@typespec/versioning"; + +import "./resourcetypes/approvals/approvals.tsp"; +import "./resourcetypes/community/community.tsp"; +import "./resourcetypes/communityEndpoint/communityEndpoint.tsp"; +import "./resourcetypes/enclaveConnection/enclaveConnection.tsp"; +import "./resourcetypes/enclaveEndpoint/enclaveEndpoint.tsp"; +import "./resourcetypes/postActions/approvalspostactions.tsp"; +import "./resourcetypes/postActions/checkaddressspaceavailability.tsp"; +import "./resourcetypes/transitHub/transitHub.tsp"; +import "./resourcetypes/virtualEnclave/virtualenclave.tsp"; +import "./resourcetypes/workload/workload.tsp"; + +import "./resourcetypes/shared/endpointrulebase.tsp"; +import "./resourcetypes/shared/governedserviceitem.tsp"; +import "./resourcetypes/shared/maintenancemodeconfiguration.tsp"; +import "./resourcetypes/shared/managedresourcegroupconfiguration.tsp"; +import "./resourcetypes/shared/principal.tsp"; +import "./resourcetypes/shared/provisioningstate.tsp"; +import "./resourcetypes/shared/resourceid.tsp"; +import "./resourcetypes/shared/roleassignmentitem.tsp"; + +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; + +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Arm resource update successful") +model ArmUpdatedResponse + is ArmResponse; + +@doc("Community Model Resource") +model CommunityResource is TrackedResource { + @key("communityName") + @segment("communities") + @pattern("^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$") + @path + @doc("The name of the communityResource Resource") + name: string; + + /** The managed service identity for this resource */ + ...ManagedServiceIdentityProperty; +} + +@@added(CommunityResource.identity, + Microsoft.Mission.Versions.v2024_06_01_preview +); + +@doc("Virtual Enclave Model Resource") +model EnclaveResource is TrackedResource { + @key("virtualEnclaveName") + @segment("virtualEnclaves") + @pattern("^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$") + @doc("The name of the enclaveResource Resource") + @path + name: string; + + /** The managed service identity for this resource */ + ...ManagedServiceIdentityProperty; +} + +@@added(EnclaveResource.identity, + Microsoft.Mission.Versions.v2024_06_01_preview +); + +@doc("Workload Model Resource") +@parentResource(EnclaveResource) +model WorkloadResource is TrackedResource { + @key("workloadName") + @segment("workloads") + @pattern("^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$") + @path + @doc("The name of the workloadResource Resource") + name: string; +} + +@doc("TransitHub Model Resource") +@parentResource(CommunityResource) +model TransitHubResource is TrackedResource { + @key("transitHubName") + @segment("transitHubs") + @path + @pattern("^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$") + @doc("The name of the TransitHub Resource") + name: string; +} + +@doc("EnclaveConnection Model Resource") +model EnclaveConnectionResource + is TrackedResource { + @key("enclaveConnectionName") + @segment("enclaveConnections") + @path + @pattern("^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$") + @doc("The name of the Enclave Connection Resource") + name: string; +} + +@doc("EnclaveEndpoint Model Resource") +@parentResource(EnclaveResource) +model EnclaveEndpointResource is TrackedResource { + @key("enclaveEndpointName") + @segment("enclaveEndpoints") + @path + @pattern("^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$") + @doc("The name of the Enclave Endpoint Resource") + name: string; +} + +@doc("CommunityEndpoint Model Resource") +@parentResource(CommunityResource) +model CommunityEndpointResource + is TrackedResource { + @key("communityEndpointName") + @segment("communityEndpoints") + @path + @pattern("^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$") + @doc("The name of the Community Endpoint Resource") + name: string; +} + +@doc("Approval Model Resource") +model ApprovalResource is ExtensionResource { + @key("approvalName") + @segment("approvals") + @path + @pattern("^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$") + @doc("The name of the approvals resource.") + name: string; +} diff --git a/specification/mission/Mission.Management/resourcetypes/approvals/approvals.tsp b/specification/mission/Mission.Management/resourcetypes/approvals/approvals.tsp new file mode 100644 index 000000000000..af7914a565c1 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/approvals/approvals.tsp @@ -0,0 +1,128 @@ +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "@typespec/versioning"; + +using TypeSpec.Versioning; +using Azure.Core; + +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Approval Status. It can be Approved, Rejected, Pending, Deleted or Expired.") +union ApprovalStatus { + string, + + @doc("ApprovalStatus Type Approved") + Approved: "Approved", + + @doc("ApprovalStatus Type Rejected") + Rejected: "Rejected", + + @doc("ApprovalStatus Type Pending") + Pending: "Pending", + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("ApprovalStatus Type Deleted") + Deleted: "Deleted", + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("ApprovalStatus Type Expired") + Expired: "Expired", +} + +@doc("Specifies the action performed by the approver") +union ActionPerformed { + string, + + @doc("Action was Approved") + Approved: "Approved", + + @doc("Action was Rejected") + Rejected: "Rejected", +} + +@doc("Request Metadata for approvals request.") +model RequestMetadata { + @doc("Resource Action of the item being approved or declined.") + resourceAction: string; + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Route name for the approval callback") + approvalCallbackRoute?: string; + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Payload to be sent upon any action on approval request") + approvalCallbackPayload?: string; + + @doc("Status of the approval. Uses ApprovalStatus enum.") + approvalStatus?: ApprovalStatus = ApprovalStatus.Pending; +} + +@renamedFrom(Microsoft.Mission.Versions.v2024_12_01_preview, "Approvers") +@doc("Approver Metadata for approvals request.") +model Approver { + @doc("Entra ObjectID of the approver") + approverEntraId: string; + + @doc("Action Performed by approver") + actionPerformed?: ActionPerformed; + + @doc("approval request last updated at") + lastUpdatedAt: utcDateTime; +} + +@doc("Approval Base model.") +model ApprovalBaseModel { + @doc("Provisioning State.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Parameter for optimizing query results") + @renamedFrom(Microsoft.Mission.Versions.v2025_05_01_preview, "parent1") + @typeChangedFrom(Microsoft.Mission.Versions.v2025_05_01_preview, string) + parentResourceId?: armResourceIdentifier; + + @doc("Parameter for optimizing query results") + @renamedFrom(Microsoft.Mission.Versions.v2025_05_01_preview, "parent2") + @typeChangedFrom(Microsoft.Mission.Versions.v2025_05_01_preview, string) + grandparentResourceId?: armResourceIdentifier; + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @OpenAPI.extension("x-ms-identifiers", #["approverEntraId"]) + @doc("List of approvers for the approval request") + approvers?: Approver[]; + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Ticket ID for the approval request") + ticketId?: string; + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Approval request creation time") + createdAt?: utcDateTime; + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Approval request state change time, time at which approval request state changed from pending to approved or rejected.") + stateChangedAt?: utcDateTime; +} + +model ApprovalProperties is ApprovalBaseModel { + @doc("Request metadata for the approval request.") + requestMetadata: RequestMetadata; +} + +@doc("Request Metadata patch properties.") +model RequestMetadataUpdatableProperties + is UpdateableProperties>; + +@doc("Approvals patch properties.") +model ApprovalPatchProperties + is UpdateableProperties> { + @doc("Request metadata for the approval request.") + requestMetadata: RequestMetadataUpdatableProperties; +} + +@doc("Approvals patch model.") +model ApprovalPatchModel { + @doc("Approval Patch properties") + properties?: ApprovalPatchProperties; +} diff --git a/specification/mission/Mission.Management/resourcetypes/community/community.tsp b/specification/mission/Mission.Management/resourcetypes/community/community.tsp new file mode 100644 index 000000000000..8ee99e7118d2 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/community/community.tsp @@ -0,0 +1,206 @@ +// cspell:enableCompoundWords +// cspell:words managedonbehalfofconfiguration + +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "../shared/maintenancemodeconfiguration.tsp"; + +using Azure.ResourceManager; +using TypeSpec.Versioning; +using Azure.Core; + +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Azure Firewall SKU") +union FirewallSKU { + string, + + @doc("FirewallSKU Basic") + Basic: "Basic", + + @doc("FirwallSKU Standard") + Standard: "Standard", + + @doc("FirewallSKU Premium") + Premium: "Premium", +} + +@added(Microsoft.Mission.Versions.v2024_12_01_preview) +@doc("Approval Policy.") +union ApprovalPolicy { + string, + + @doc("Approval will be required for the specified action.") + Required: "Required", + + @doc("Approval will not be required for the specified action.") + NotRequired: "NotRequired", +} + +@added(Microsoft.Mission.Versions.v2024_12_01_preview) +@doc("Approver Metadata for approvals request.") +model MandatoryApprover { + @doc("EntraId of the approver") + approverEntraId: string; +} + +@added(Microsoft.Mission.Versions.v2024_12_01_preview) +@doc("ApprovalSettings Properties") +model ApprovalSettings { + @doc("Approval required for endpoint creation (Required or NotRequired).") + @visibility(Lifecycle.Read, Lifecycle.Create) + endpointCreation?: ApprovalPolicy; + + @doc("Approval required for endpoint update (Required or NotRequired).") + @visibility(Lifecycle.Read, Lifecycle.Create) + endpointUpdate?: ApprovalPolicy; + + @doc("Approval required for endpoint deletion (Required or NotRequired).") + @visibility(Lifecycle.Read, Lifecycle.Create) + endpointDeletion?: ApprovalPolicy; + + @doc("Approval required for enclave connection creation (Required or NotRequired).") + @visibility(Lifecycle.Read, Lifecycle.Create) + connectionCreation?: ApprovalPolicy; + + @doc("Approval required for enclave connection update (Required or NotRequired).") + @visibility(Lifecycle.Read, Lifecycle.Create) + connectionUpdate?: ApprovalPolicy; + + @doc("Approval required for enclave connection deletion (Required or NotRequired).") + @visibility(Lifecycle.Read, Lifecycle.Create) + connectionDeletion?: ApprovalPolicy; + + @doc("Approval required for virtual enclave creation (Required or NotRequired).") + @visibility(Lifecycle.Read, Lifecycle.Create) + enclaveCreation?: ApprovalPolicy; + + @doc("Approval required for virtual enclave deletion (Required or NotRequired).") + @visibility(Lifecycle.Read, Lifecycle.Create) + enclaveDeletion?: ApprovalPolicy; + + @doc("Approval required for toggling maintenance mode (Required or NotRequired).") + @visibility(Lifecycle.Read, Lifecycle.Create) + maintenanceMode?: ApprovalPolicy; + + @doc("Approval required for deploying service catalog templates (Required or NotRequired).") + @visibility(Lifecycle.Read, Lifecycle.Create) + serviceCatalogDeployment?: ApprovalPolicy; + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Notification will be sent on creation of an Approval Request") + @visibility(Lifecycle.Read, Lifecycle.Create) + notificationOnApprovalCreation?: ApprovalPolicy; + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Notification will be sent on any action taken (Approve/Reject) on an Approval Request") + @visibility(Lifecycle.Read, Lifecycle.Create) + notificationOnApprovalAction?: ApprovalPolicy; + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Notification will be sent on deletion of an Approval Request") + @visibility(Lifecycle.Read, Lifecycle.Create) + notificationOnApprovalDeletion?: ApprovalPolicy; + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @OpenAPI.extension("x-ms-identifiers", #["approverEntraId"]) + @doc("List of mandatory approvers for the approval request") + mandatoryApprovers?: MandatoryApprover[]; + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Minimum number of approvers required for the approval request") + @visibility(Lifecycle.Read, Lifecycle.Create) + minimumApproversRequired?: int64; +} + +@added(Microsoft.Mission.Versions.v2024_12_01_preview) +@doc("ApprovalSettings Properties") +model ApprovalSettingsPatchProperties + is UpdateableProperties>; + +@doc("Community Resource Properties") +model CommunityBaseModel { + @doc("Address Space.") + @visibility(Lifecycle.Read, Lifecycle.Create) + addressSpace?: string; + + @doc("DNS Servers.") + dnsServers?: string[]; + + @doc("Provisioning State.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("List of resource ids created by communities.") + @visibility(Lifecycle.Read) + @typeChangedFrom(Microsoft.Mission.Versions.v2025_05_01_preview, string[]) + resourceCollection?: armResourceIdentifier[]; + + @doc("Managed resource group name.") + @visibility(Lifecycle.Read) + @renamedFrom( + Microsoft.Mission.Versions.v2025_05_01_preview, + "managedResourceGroupConfiguration" + ) + @typeChangedFrom( + Microsoft.Mission.Versions.v2025_05_01_preview, + ManagedResourceGroupConfiguration + ) + managedResourceGroupName?: string; + + @added(Microsoft.Mission.Versions.v2025_05_01_preview) + @doc("Managed On Behalf Of Configuration.") + @visibility(Lifecycle.Read) + managedOnBehalfOfConfiguration?: CommonTypes.ManagedOnBehalfOfConfiguration; + + @doc("List of services governed by a community.") + @OpenAPI.extension("x-ms-identifiers", #[]) + governedServiceList?: GovernedServiceItem[]; + + @added(Microsoft.Mission.Versions.v2025_05_01_preview) + @doc("Policy override setting for the community. Specifies whether to apply enclave-specific policies or disable policy enforcement.") + policyOverride?: "Enclave" | "None" | string; + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Community role assignments") + @OpenAPI.extension("x-ms-identifiers", #[]) + communityRoleAssignments?: RoleAssignmentItem[]; + + @added(Microsoft.Mission.Versions.v2025_05_01_preview) + @doc("SKU of the community's Azure Firewall (Basic, Standard, Premium). Standard is the default") + firewallSku?: FirewallSKU = FirewallSKU.Standard; +} + +@doc("Community Resource Properties") +model CommunityProperties is CommunityBaseModel { + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Approval requirements for various actions on the community's resources.") + approvalSettings?: ApprovalSettings; + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Maintenance Mode configuration.") + maintenanceModeConfiguration?: MaintenanceModeConfigurationModel; +} + +@doc("Community Resource Properties without default values") +model CommunityPatchProperties + is UpdateableProperties> { + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Approval requirements for various actions on the community's resources.") + approvalSettings?: ApprovalSettingsPatchProperties; + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Maintenance Mode configuration.") + maintenanceModeConfiguration?: MaintenanceModeConfigurationPatchModel; +} + +@doc("Community Patch Resource") +model CommunityPatchModel { + @doc("Community Patch properties") + properties?: CommunityPatchProperties; + + ...Azure.ResourceManager.Foundations.ArmTagsProperty; + ...ManagedServiceIdentityProperty; +} diff --git a/specification/mission/Mission.Management/resourcetypes/communityEndpoint/communityEndpoint.tsp b/specification/mission/Mission.Management/resourcetypes/communityEndpoint/communityEndpoint.tsp new file mode 100644 index 000000000000..d8e797735de0 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/communityEndpoint/communityEndpoint.tsp @@ -0,0 +1,103 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "@typespec/versioning"; + +using OpenAPI; +using TypeSpec.Versioning; +using Azure.Core; + +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Community Endpoint Protocol Enum") +union CommunityEndpointProtocol { + string, + + @doc("CommunityEndpointProtocol Type ANY") + ANY: "ANY", + + @doc("CommunityEndpointProtocol Type TCP") + TCP: "TCP", + + @doc("CommunityEndpointProtocol Type UDP") + UDP: "UDP", + + @doc("CommunityEndpointProtocol Type ICMP") + ICMP: "ICMP", + + @doc("CommunityEndpointProtocol Type ESP") + ESP: "ESP", + + @doc("CommunityEndpointProtocol Type AH") + AH: "AH", + + @doc("CommunityEndpointProtocol Type HTTPS") + HTTPS: "HTTPS", + + @doc("CommunityEndpointProtocol Type HTTP") + HTTP: "HTTP", +} + +@doc("Destination Type Enum") +union DestinationType { + string, + + @doc("DestinationType Type FQDN") + FQDN: "FQDN", + + @doc("DestinationType Type FQDNTag") + FQDNTag: "FQDNTag", + + @doc("DestinationType Type IPAddress") + IPAddress: "IPAddress", + + @doc("DestinationType Type PrivateNetwork") + PrivateNetwork: "PrivateNetwork", +} + +@doc("Base type for destination rules.") +model CommunityEndpointDestinationRule { + @doc("Destination Type.") + destinationType?: DestinationType; + + @doc("Protocols. Options specified by Endpoint Protocol Enum.") + protocols?: CommunityEndpointProtocol[]; + + @doc("Transit Hub Resource Id.") + transitHubResourceId?: TransitHubResourceId; + + ...EndpointRuleBase; +} + +@doc("Community Endpoint Resource properties") +model CommunityEndpointProperties { + @extension("x-ms-identifiers", #[]) + @doc("Community Endpoint Rule Collection.") + ruleCollection: CommunityEndpointDestinationRule[]; + + @doc("List of resource ids created by community endpoint.") + @visibility(Lifecycle.Read) + @typeChangedFrom(Microsoft.Mission.Versions.v2025_05_01_preview, string[]) + resourceCollection?: armResourceIdentifier[]; + + @doc("Provisioning State.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @removed(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Whether approval is needed for the connection (True or False).") + approvalRequired?: boolean; +} + +@doc("Community Endpoint patchable Properties") +model CommunityEndpointPatchProperties + is UpdateableProperties>; + +@doc("Community Endpoint Patch Resource") +model CommunityEndpointPatchModel { + @doc("Community Endpoint Patch properties") + properties?: CommunityEndpointPatchProperties; + + ...Azure.ResourceManager.Foundations.ArmTagsProperty; +} diff --git a/specification/mission/Mission.Management/resourcetypes/enclaveConnection/enclaveConnection.tsp b/specification/mission/Mission.Management/resourcetypes/enclaveConnection/enclaveConnection.tsp new file mode 100644 index 000000000000..cd7aa97bb973 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/enclaveConnection/enclaveConnection.tsp @@ -0,0 +1,84 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "@typespec/versioning"; + +using TypeSpec.Versioning; +using Azure.Core; + +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Specifies the state of the enclave connection.") +union EnclaveConnectionState { + string, + + @doc("EnclaveConnectionState Type Pending Approval") + PendingApproval: "PendingApproval", + + @doc("EnclaveConnectionState Type Pending Update") + PendingUpdate: "PendingUpdate", + + @doc("EnclaveConnectionState Type Approved") + Approved: "Approved", + + @doc("EnclaveConnectionState Type Active") + Active: "Active", + + @doc("EnclaveConnectionState Type Failed") + Failed: "Failed", + + @doc("EnclaveConnectionState Type Connected") + Connected: "Connected", + + @doc("EnclaveConnectionState Type Disconnected") + Disconnected: "Disconnected", +} + +@doc("Enclave Connection Resource properties") +model EnclaveConnectionProperties { + @doc("The state of the enclaveConnection.") + @visibility(Lifecycle.Read) + state?: EnclaveConnectionState; + + @doc("Community Resource Id.") + @visibility(Lifecycle.Read, Lifecycle.Create) + communityResourceId: CommunityResourceId; + + @doc("Source Resource Id.") + @visibility(Lifecycle.Read, Lifecycle.Create) + sourceResourceId: EnclaveConnectionSourceResourceId; + + @doc("Source CIDR.") + sourceCidr?: string; + + @removed(Microsoft.Mission.Versions.v2025_05_01_preview) + @doc("Source IP group Resource Id.") + @visibility(Lifecycle.Read, Lifecycle.Create) + ipGroup?: IPGroupResourceId; + + @doc("Destination Endpoint Resource Id.") + @visibility(Lifecycle.Read, Lifecycle.Create) + destinationEndpointId: DestinationEndpointResourceId; + + @doc("Provisioning State.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("List of resource ids modified by enclave Connections.") + @visibility(Lifecycle.Read) + @typeChangedFrom(Microsoft.Mission.Versions.v2025_05_01_preview, string[]) + resourceCollection?: armResourceIdentifier[]; +} + +@doc("Enclave Connection patchable Properties") +model EnclaveConnectionPatchProperties + is UpdateableProperties>; + +@doc("Enclave Connection Patch Resource") +model EnclaveConnectionPatchModel { + @doc("Enclave Connection Patch properties") + properties?: EnclaveConnectionPatchProperties; + + ...Azure.ResourceManager.Foundations.ArmTagsProperty; +} diff --git a/specification/mission/Mission.Management/resourcetypes/enclaveEndpoint/enclaveEndpoint.tsp b/specification/mission/Mission.Management/resourcetypes/enclaveEndpoint/enclaveEndpoint.tsp new file mode 100644 index 000000000000..7c4fc7c63204 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/enclaveEndpoint/enclaveEndpoint.tsp @@ -0,0 +1,74 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "@typespec/versioning"; + +using OpenAPI; +using TypeSpec.Versioning; +using Azure.Core; + +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Enclave Endpoint Protocol Enum") +union EnclaveEndpointProtocol { + string, + + @doc("EndpointProtocol Type ANY") + ANY: "ANY", + + @doc("EndpointProtocol Type TCP") + TCP: "TCP", + + @doc("EndpointProtocol Type UDP") + UDP: "UDP", + + @doc("EndpointProtocol Type ICMP") + ICMP: "ICMP", + + @doc("EndpointProtocol Type ESP") + ESP: "ESP", + + @doc("EndpointProtocol Type AH") + AH: "AH", +} + +@doc("Enclave Endpoint Rule Properties") +model EnclaveEndpointDestinationRule { + @doc("Protocols. Options specified by Endpoint Protocol Enum.") + protocols?: EnclaveEndpointProtocol[]; + + ...EndpointRuleBase; +} + +@doc("Enclave Endpoint Resource properties") +model EnclaveEndpointProperties { + @extension("x-ms-identifiers", #[]) + @doc("Enclave Endpoint Rule Collection.") + ruleCollection: EnclaveEndpointDestinationRule[]; + + @doc("List of resource ids created by community endpoint.") + @visibility(Lifecycle.Read) + @typeChangedFrom(Microsoft.Mission.Versions.v2025_05_01_preview, string[]) + resourceCollection?: armResourceIdentifier[]; + + @doc("Provisioning State.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @removed(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Whether approval is needed for the connection (True or False).") + approvalRequired?: boolean; +} + +@doc("Enclave Endpoint patchable Properties") +model EnclaveEndpointPatchProperties + is UpdateableProperties>; + +@doc("Enclave Endpoint Patch Resource") +model EnclaveEndpointPatchModel { + @doc("Enclave Endpoint Patch properties") + properties?: EnclaveEndpointPatchProperties; + + ...Azure.ResourceManager.Foundations.ArmTagsProperty; +} diff --git a/specification/mission/Mission.Management/resourcetypes/postActions/approvalspostactions.tsp b/specification/mission/Mission.Management/resourcetypes/postActions/approvalspostactions.tsp new file mode 100644 index 000000000000..34df89820d98 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/postActions/approvalspostactions.tsp @@ -0,0 +1,47 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "@typespec/versioning"; + +using Azure.Core; +using TypeSpec.Versioning; + +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Request body for calling post-action") +model ApprovalCallbackRequest { + @removed(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Resource Id of the item being approved or rejected") + resourceId: armResourceIdentifier; + + @doc("Resource request action indicating action which needed to be performed upon calling approval-callback post action") + resourceRequestAction: "Create" | "Delete" | "Update" | "Reset" | string; + + @doc("Approval status indicating 'Approved' or 'Rejected'") + approvalStatus: "Approved" | "Rejected" | string; + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Payload requested by client upon approval action") + approvalCallbackPayload?: string; +} + +// Define a model for the approval initator callback request +@doc("Request body for calling post-action") +model ApprovalActionRequest { + @doc("Approval status indicating 'Approved' or 'Rejected'") + approvalStatus: "Approved" | "Rejected" | string; +} + +// Define a model for the approval initator callback response +@doc("Response body after handling of approvalCallbackRequest") +model ApprovalActionResponse { + @doc("Confirmation message indicating the result of the operation.") + message: string; +} + +@doc("Request body for calling post-action") +model ApprovalDeletionCallbackRequest { + @doc("Resource request action indicating action which needed to be performed upon calling approval-deletion-callback post action") + resourceRequestAction: "Create" | "Delete" | "Update" | string; +} diff --git a/specification/mission/Mission.Management/resourcetypes/postActions/checkaddressspaceavailability.tsp b/specification/mission/Mission.Management/resourcetypes/postActions/checkaddressspaceavailability.tsp new file mode 100644 index 000000000000..77bd7748d4c8 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/postActions/checkaddressspaceavailability.tsp @@ -0,0 +1,17 @@ +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Request to the action call to check address space availability.") +model CheckAddressSpaceAvailabilityRequest { + @doc("Resource Id of the Community") + communityResourceId: CommunityResourceId; + + @doc("Information about the enclave virtual network") + enclaveVirtualNetwork: EnclaveVirtualNetworkModel; +} + +@doc("Response of availability of the requested address space.") +model CheckAddressSpaceAvailabilityResponse { + @doc("Boolean representing whether the address space is available.") + value: boolean; +} diff --git a/specification/mission/Mission.Management/resourcetypes/shared/endpointrulebase.tsp b/specification/mission/Mission.Management/resourcetypes/shared/endpointrulebase.tsp new file mode 100644 index 000000000000..9efc17d9fbb7 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/shared/endpointrulebase.tsp @@ -0,0 +1,21 @@ +import "@typespec/rest"; +import "@typespec/versioning"; + +using TypeSpec.Versioning; + +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Base Endpoint Rule Properties") +model EndpointRuleBase { + @renamedFrom(Microsoft.Mission.Versions.v2025_05_01_preview, "name") + @doc("Endpoint Rule Name.") + endpointRuleName?: string; + + @doc("Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas.") + destination?: string; + + @renamedFrom(Microsoft.Mission.Versions.v2025_05_01_preview, "port") + @doc("Port. Can include multiple ports separated by commas or a range indicated by a hyphen.") + ports?: string; +} diff --git a/specification/mission/Mission.Management/resourcetypes/shared/governedserviceitem.tsp b/specification/mission/Mission.Management/resourcetypes/shared/governedserviceitem.tsp new file mode 100644 index 000000000000..ce2fed7d9b68 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/shared/governedserviceitem.tsp @@ -0,0 +1,90 @@ +// cspell:enableCompoundWords +// cspell:words managedonbehalfofconfiguration + +import "@typespec/rest"; +import "@typespec/versioning"; + +using TypeSpec.Versioning; + +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Identifier for governed services.") +union ServiceIdentifier { + string, + + @doc("Service identifier for AKS") + AKS: "AKS", + + @doc("Service identifier for App Service") + AppService: "AppService", + + @doc("Service identifier for Azure Firewalls") + AzureFirewalls: "AzureFirewalls", + + @doc("Service identifier for Container Registry") + ContainerRegistry: "ContainerRegistry", + + @doc("Service identifier for CosmosDB") + CosmosDB: "CosmosDB", + + @doc("Service identifier for Data Connectors") + DataConnectors: "DataConnectors", + + @doc("Service identifier for Insights") + Insights: "Insights", + + @doc("Service identifier for Key Vault") + KeyVault: "KeyVault", + + @doc("Service identifier for Logic") + Logic: "Logic", + + @doc("Service identifier for Microsoft SQL") + MicrosoftSql: "MicrosoftSQL", + + @doc("Service identifier for Monitoring") + Monitoring: "Monitoring", + + @doc("Service identifier for PostgreSQL") + PostgreSql: "PostgreSQL", + + @doc("Service identifier for Private DNS Zones") + PrivateDNSZones: "PrivateDNSZones", + + @doc("Service identifier for Service Bus") + ServiceBus: "ServiceBus", + + @doc("Service identifier for Storage") + Storage: "Storage", +} + +@doc("GovernedServiceItem Properties") +model GovernedServiceItem { + @renamedFrom(Microsoft.Mission.Versions.v2025_05_01_preview, "id") + @doc("Service ID") + serviceId: ServiceIdentifier; + + @renamedFrom(Microsoft.Mission.Versions.v2025_05_01_preview, "name") + @doc("Service name.") + @visibility(Lifecycle.Read) + serviceName?: string; + + @doc("Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable).") + option?: "Allow" | "Deny" | "ExceptionOnly" | "NotApplicable" | string; + + @doc("Initiative enforcement (Enabled or Disabled).") + enforcement?: "Enabled" | "Disabled" | string; + + @removed(Microsoft.Mission.Versions.v2025_05_01_preview) + @doc("Policies set to auditOnly (True or False).") + auditOnly?: boolean; + + @added(Microsoft.Mission.Versions.v2025_05_01_preview) + @doc("Enforcement mode for policy. AuditOnly, Enforce, or None.") + policyAction?: "AuditOnly" | "Enforce" | "None" | string; + + @doc("Initiatives associated with this service.") + @visibility(Lifecycle.Read) + initiatives?: string[]; +} diff --git a/specification/mission/Mission.Management/resourcetypes/shared/maintenancemodeconfiguration.tsp b/specification/mission/Mission.Management/resourcetypes/shared/maintenancemodeconfiguration.tsp new file mode 100644 index 000000000000..9d6763cc0007 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/shared/maintenancemodeconfiguration.tsp @@ -0,0 +1,20 @@ +import "./principal.tsp"; + +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Maintenance Mode") +model MaintenanceModeConfigurationModel { + @doc("Current mode of Maintenance Mode Configuration") + mode: "On" | "CanNotDelete" | "Off" | "General" | "Advanced" | string = "Off"; + + @doc("The user, group or service principal object affected by Maintenance Mode") + principals?: Principal[] = #[]; + + @doc("Justification for entering or exiting Maintenance Mode") + justification?: "Networking" | "Governance" | "Off" | string = "Off"; +} + +@doc("Maintenance Mode Patch Model") +model MaintenanceModeConfigurationPatchModel + is UpdateableProperties>; diff --git a/specification/mission/Mission.Management/resourcetypes/shared/managedresourcegroupconfiguration.tsp b/specification/mission/Mission.Management/resourcetypes/shared/managedresourcegroupconfiguration.tsp new file mode 100644 index 000000000000..ac05537ee218 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/shared/managedresourcegroupconfiguration.tsp @@ -0,0 +1,19 @@ +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "@typespec/versioning"; + +using Azure.Core; +using TypeSpec.Versioning; +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@removed(Microsoft.Mission.Versions.v2025_05_01_preview) +@doc("ManagedResourceGroup related properties") +model ManagedResourceGroupConfiguration { + @doc("Name of managed resource group") + name?: string; + + @doc("The geo-location where the resource lives") + @visibility(Lifecycle.Read, Lifecycle.Create) + location?: azureLocation; +} diff --git a/specification/mission/Mission.Management/resourcetypes/shared/principal.tsp b/specification/mission/Mission.Management/resourcetypes/shared/principal.tsp new file mode 100644 index 000000000000..ebf7a945c707 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/shared/principal.tsp @@ -0,0 +1,11 @@ +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Principal for maintenance mode or role assignments") +model Principal { + @doc("The object id associated with the principal") + id: string; + + @doc("The type of the object id. We currently allow users, groups, and service principals") + type: "User" | "Group" | "ServicePrincipal" | string; +} diff --git a/specification/mission/Mission.Management/resourcetypes/shared/provisioningstate.tsp b/specification/mission/Mission.Management/resourcetypes/shared/provisioningstate.tsp new file mode 100644 index 000000000000..09946cf9fdc2 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/shared/provisioningstate.tsp @@ -0,0 +1,32 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Azure.Core; +using Azure.ResourceManager; + +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@lroStatus +@doc("The provisioning status of the resource.") +union ProvisioningState { + ResourceProvisioningState, + + @doc("Provisioning State Type Accepted") + Accepted: "Accepted", + + @doc("Provisioning State Type Creating") + Creating: "Creating", + + @doc("Provisioning State Type Deleting") + Deleting: "Deleting", + + @doc("Provisioning State Type NotSpecified") + NotSpecified: "NotSpecified", + + @doc("Provisioning State Type Running") + Running: "Running", + + @doc("Provisioning State Type Updating") + Updating: "Updating", +} diff --git a/specification/mission/Mission.Management/resourcetypes/shared/resourceid.tsp b/specification/mission/Mission.Management/resourcetypes/shared/resourceid.tsp new file mode 100644 index 000000000000..c1be768135a4 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/shared/resourceid.tsp @@ -0,0 +1,101 @@ +import "@typespec/rest"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/versioning"; + +using TypeSpec.Versioning; +using Azure.Core; + +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +scalar VirtualEnclaveResourceId + extends armResourceIdentifier<[ + { + type: "Microsoft.Mission/virtualEnclaves", + } + ]>; + +scalar VirtualNetworkResourceId + extends armResourceIdentifier<[ + { + type: "Microsoft.Network/virtualNetworks", + } + ]>; + +scalar SubnetResourceId + extends armResourceIdentifier<[ + { + type: "Microsoft.Network/virtualNetworks/subnets", + } + ]>; + +scalar NsgResourceId + extends armResourceIdentifier<[ + { + type: "Microsoft.Network/networkSecurityGroups", + } + ]>; + +scalar CommunityResourceId + extends armResourceIdentifier<[ + { + type: "Microsoft.Mission/communities", + } + ]>; + +scalar KeyVaultResourceId + extends armResourceIdentifier<[ + { + type: "Microsoft.KeyVault/vaults", + } + ]>; + +scalar LogAnalyticsResourceId + extends armResourceIdentifier<[ + { + type: "Microsoft.OperationalInsights/workspaces", + } + ]>; + +scalar StorageAccountResourceId + extends armResourceIdentifier<[ + { + type: "Microsoft.Storage/storageAccounts", + } + ]>; + +scalar EnclaveConnectionSourceResourceId + extends armResourceIdentifier<[ + { + type: "Microsoft.Mission/virtualEnclaves", + }, + { + type: "Microsoft.Mission/communities/transitHubs", + } + ]>; + +scalar DestinationEndpointResourceId + extends armResourceIdentifier<[ + { + type: "Microsoft.Mission/virtualEnclaves/enclaveEndpoints", + }, + { + type: "Microsoft.Mission/communities/communityEndpoints", + } + ]>; + +scalar TransitHubResourceId + extends armResourceIdentifier<[ + { + type: "Microsoft.Mission/communities/transitHubs", + } + ]>; + +@removed(Microsoft.Mission.Versions.v2025_05_01_preview) +scalar IPGroupResourceId + extends armResourceIdentifier<[ + { + type: "Microsoft.Network/IpGroups", + } + ]>; diff --git a/specification/mission/Mission.Management/resourcetypes/shared/roleassignmentitem.tsp b/specification/mission/Mission.Management/resourcetypes/shared/roleassignmentitem.tsp new file mode 100644 index 000000000000..f5c2bb7760b8 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/shared/roleassignmentitem.tsp @@ -0,0 +1,16 @@ +import "@typespec/rest"; +import "@typespec/versioning"; + +using TypeSpec.Versioning; +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Role assignment item that indicates which principals should be assigned this role definition") +model RoleAssignmentItem { + @renamedFrom(Microsoft.Mission.Versions.v2025_05_01_preview, "id") + @doc("Role definition identifier") + roleDefinitionId: string; + + @doc("List of principal IDs to which to assign this role definition") + principals?: Principal[]; +} diff --git a/specification/mission/Mission.Management/resourcetypes/transitHub/transitHub.tsp b/specification/mission/Mission.Management/resourcetypes/transitHub/transitHub.tsp new file mode 100644 index 000000000000..4b0d69039933 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/transitHub/transitHub.tsp @@ -0,0 +1,92 @@ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Azure.Core; +using TypeSpec.Versioning; + +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Specifies the state of the transitHub.") +union TransitHubState { + string, + + @doc("TransitHubState Type PendingApproval") + PendingApproval: "PendingApproval", + + @doc("TransitHubState Type Approved") + Approved: "Approved", + + @doc("TransitHubState Type PendingUpdate") + PendingUpdate: "PendingUpdate", + + @doc("TransitHubState Type Active") + Active: "Active", + + @doc("TransitHubState Type Failed") + Failed: "Failed", +} + +@doc("Specifies the type of the transitOption.") +union TransitOptionType { + string, + + @doc("TransitOptionType ExpressRoute") + ExpressRoute: "ExpressRoute", + + @doc("TransitOptionType Gateway") + Gateway: "Gateway", + + @doc("TransitOptionType Peering") + Peering: "Peering", +} + +@doc("TransitOptionParams Properties") +model TransitOptionParams { + @doc("Transit Option Params scaleUnits.") + scaleUnits?: int64; + + @doc("Transit Option Params remoteVirtualNetworkId.") + remoteVirtualNetworkId?: VirtualNetworkResourceId; +} + +@doc("TransitOption Properties") +model TransitOption { + @doc("Transit Option Type.") + type?: TransitOptionType; + + @doc("Transit Option Params") + params?: TransitOptionParams; +} + +@doc("Describes the properties of an Transit Hub.") +model TransitHubProperties { + @doc("The status of the last operation.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("The state of the transitHub.") + state?: TransitHubState; + + @doc("The TransitOption of the transitHub.") + transitOption?: TransitOption; + + @doc("List of resource ids modified by transitHubs.") + @visibility(Lifecycle.Read) + @typeChangedFrom(Microsoft.Mission.Versions.v2025_05_01_preview, string[]) + resourceCollection?: armResourceIdentifier[]; +} + +@doc("Transit Hub patchable Properties") +model TransitHubPatchProperties + is UpdateableProperties>; + +@doc("TH Patch Resource") +model TransitHubPatchModel { + @doc("The TransitHub resource.") + properties?: TransitHubPatchProperties; + + ...Azure.ResourceManager.Foundations.ArmTagsProperty; +} diff --git a/specification/mission/Mission.Management/resourcetypes/virtualEnclave/virtualenclave.tsp b/specification/mission/Mission.Management/resourcetypes/virtualEnclave/virtualenclave.tsp new file mode 100644 index 000000000000..e3eaa9d39235 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/virtualEnclave/virtualenclave.tsp @@ -0,0 +1,203 @@ +// cspell:enableCompoundWords +// cspell:words managedonbehalfofconfiguration + +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "../shared/maintenancemodeconfiguration.tsp"; + +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Versioning; + +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Specifies the destination of where to store diagnostic logs.") +union DiagnosticDestination { + string, + + @doc("DiagnosticDestination Type CommunityOnly") + CommunityOnly: "CommunityOnly", + + @doc("DiagnosticDestination Type EnclaveOnly") + EnclaveOnly: "EnclaveOnly", + + @doc("DiagnosticDestination Type Both") + Both: "Both", +} + +@doc("Subnet Configuration") +model SubnetConfiguration { + @renamedFrom(Microsoft.Mission.Versions.v2025_05_01_preview, "name") + @doc("Subnet name.") + subnetName: string; + + @renamedFrom(Microsoft.Mission.Versions.v2025_05_01_preview, "id") + @doc("Subnet Resource ID.") + @visibility(Lifecycle.Read) + subnetResourceId?: SubnetResourceId; + + @doc("Network prefix size.") + networkPrefixSize: int32; + + @doc("Subnet delegation.") + subnetDelegation?: string; + + @doc("Address prefix.") + @visibility(Lifecycle.Read) + addressPrefix?: string; + + @renamedFrom( + Microsoft.Mission.Versions.v2025_05_01_preview, + "networkSecurityGroupId" + ) + @doc("Network security group ID.") + @visibility(Lifecycle.Read) + networkSecurityGroupResourceId?: NsgResourceId; +} + +@doc("Enclave Virtual Network Properties") +model EnclaveVirtualNetworkModel { + @renamedFrom(Microsoft.Mission.Versions.v2025_05_01_preview, "name") + @doc("Network Name.") + networkName?: string; + + @doc("Network Size.") + @visibility(Lifecycle.Read, Lifecycle.Create) + networkSize?: string; + + @doc("Custom CIDR Range.") + @visibility(Lifecycle.Read, Lifecycle.Create) + customCidrRange?: string; + + @doc("Subnet Configurations.") + @OpenAPI.extension("x-ms-identifiers", #[]) + subnetConfigurations?: SubnetConfiguration[]; + + @doc("Allow Subnet Communication.") + @visibility(Lifecycle.Read, Lifecycle.Create) + allowSubnetCommunication?: boolean = false; + + @removed(Microsoft.Mission.Versions.v2025_05_01_preview) + @doc("Connect to Azure Services (True or False).") + @visibility(Lifecycle.Read, Lifecycle.Create) + connectToAzureServices?: boolean = false; +} + +@doc("Virtual Enclave Default Settings") +model EnclaveDefaultSettingsPatchModel + is UpdateableProperties>; + +@doc("Virtual Enclave Default Settings") +model EnclaveDefaultSettingsModel { + @doc("Key Vault Resource Id.") + @visibility(Lifecycle.Read) + keyVaultResourceId?: KeyVaultResourceId; + + @doc("Storage Account Resource Id.") + @visibility(Lifecycle.Read) + storageAccountResourceId?: StorageAccountResourceId; + + @doc("Log Analytics Resource Ids.") + @visibility(Lifecycle.Read) + logAnalyticsResourceIdCollection?: LogAnalyticsResourceId[]; + + @doc("Diagnostic Destination.") + diagnosticDestination?: DiagnosticDestination = DiagnosticDestination.EnclaveOnly; +} + +@doc("Enclave Address Spaces") +model EnclaveAddressSpacesModel { + @doc("Enclave Address Space") + enclaveAddressSpace?: string; + + @doc("Managed Address Space") + managedAddressSpace?: string; +} + +@doc("Virtual Enclave Resource properties") +model VirtualEnclaveBaseModel { + @doc("Provisioning State.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Virtual Network.") + enclaveVirtualNetwork: EnclaveVirtualNetworkModel; + + @doc("Enclave Address Spaces") + @visibility(Lifecycle.Read) + enclaveAddressSpaces?: EnclaveAddressSpacesModel; + + @doc("Community Resource Id.") + @visibility(Lifecycle.Read, Lifecycle.Create) + communityResourceId: CommunityResourceId; + + @doc("List of resource ids created by Virtual Enclave.") + @visibility(Lifecycle.Read) + resourceCollection?: armResourceIdentifier[]; + + @renamedFrom( + Microsoft.Mission.Versions.v2025_05_01_preview, + "managedResourceGroupConfiguration" + ) + @typeChangedFrom( + Microsoft.Mission.Versions.v2025_05_01_preview, + ManagedResourceGroupConfiguration + ) + @doc("Managed resource group name.") + @visibility(Lifecycle.Read) + managedResourceGroupName?: string; + + @added(Microsoft.Mission.Versions.v2025_05_01_preview) + @doc("Managed On Behalf Of Configuration.") + @visibility(Lifecycle.Read) + managedOnBehalfOfConfiguration?: CommonTypes.ManagedOnBehalfOfConfiguration; + + @doc("Deploy Bastion service (True or False).") + bastionEnabled?: boolean = false; + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Enclave role assignments") + @OpenAPI.extension("x-ms-identifiers", #[]) + enclaveRoleAssignments?: RoleAssignmentItem[]; + + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @doc("Workload role assignments") + @OpenAPI.extension("x-ms-identifiers", #[]) + workloadRoleAssignments?: RoleAssignmentItem[]; + + @added(Microsoft.Mission.Versions.v2025_05_01_preview) + @doc("Enclave specific policies") + @OpenAPI.extension("x-ms-identifiers", #[]) + governedServiceList?: GovernedServiceItem[]; +} + +@doc("Virtual Enclave Resource properties") +model VirtualEnclaveProperties is VirtualEnclaveBaseModel { + @doc("Enclave default settings.") + enclaveDefaultSettings?: EnclaveDefaultSettingsModel; + + @doc("Maintenance Mode configuration.") + maintenanceModeConfiguration?: MaintenanceModeConfigurationModel; +} + +@doc("Virtual Enclave Patchable Properties") +model VirtualEnclavePatchProperties + is UpdateableProperties> { + @doc("Enclave default settings.") + enclaveDefaultSettings?: EnclaveDefaultSettingsPatchModel; + + @doc("Maintenance Mode configuration.") + maintenanceModeConfiguration?: MaintenanceModeConfigurationPatchModel; +} + +@doc("Virtual Enclave Patch Model") +model VirtualEnclavePatchModel { + @doc("Virtual Enclave Patch properties") + properties?: VirtualEnclavePatchProperties; + + ...ManagedServiceIdentityProperty; + ...Azure.ResourceManager.Foundations.ArmTagsProperty; +} diff --git a/specification/mission/Mission.Management/resourcetypes/workload/workload.tsp b/specification/mission/Mission.Management/resourcetypes/workload/workload.tsp new file mode 100644 index 000000000000..0eb24dc5d2d1 --- /dev/null +++ b/specification/mission/Mission.Management/resourcetypes/workload/workload.tsp @@ -0,0 +1,40 @@ +// cspell:enableCompoundWords +// cspell:words managedonbehalfofconfiguration + +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "@typespec/versioning"; + +using Azure.ResourceManager; +using TypeSpec.Versioning; + +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Workload Resource properties") +model WorkloadProperties { + @doc("Provisioning State.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("List of resource group ids.") + resourceGroupCollection?: string[]; + + @added(Microsoft.Mission.Versions.v2025_05_01_preview) + @doc("Managed On Behalf Of Configuration.") + @visibility(Lifecycle.Read) + managedOnBehalfOfConfiguration?: CommonTypes.ManagedOnBehalfOfConfiguration; +} + +@doc("Workload patchable Properties") +model WorkloadPatchProperties + is UpdateableProperties>; + +@doc("Workload Patch Resource") +model WorkloadPatchModel { + @doc("Workload Patch properties") + properties?: WorkloadPatchProperties; + + ...Azure.ResourceManager.Foundations.ArmTagsProperty; +} diff --git a/specification/mission/Mission.Management/routes.tsp b/specification/mission/Mission.Management/routes.tsp new file mode 100644 index 000000000000..4dafcf1ddade --- /dev/null +++ b/specification/mission/Mission.Management/routes.tsp @@ -0,0 +1,291 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/openapi"; +import "@typespec/versioning"; +import "@azure-tools/typespec-autorest"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; + +import "./model.tsp"; + +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; + +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Workload Interface") +@armResourceOperations +interface Workload { + get is ArmResourceRead; + @useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + WorkloadResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader & + ArmAsyncOperationHeader + >; + update is ArmCustomPatchAsync< + WorkloadResource, + PatchModel = WorkloadPatchModel + >; + delete is ArmResourceDeleteWithoutOkAsync; + listByEnclaveResource is ArmResourceListByParent; + listBySubscription is ArmListBySubscription; +} + +@doc("Virtual Enclave Interface") +@armResourceOperations +interface VirtualEnclave { + get is ArmResourceRead; + @useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + EnclaveResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader & + ArmAsyncOperationHeader + >; + update is ArmCustomPatchAsync< + EnclaveResource, + PatchModel = VirtualEnclavePatchModel + >; + delete is ArmResourceDeleteWithoutOkAsync; + listByResourceGroup is ArmResourceListByParent; + listBySubscription is ArmListBySubscription; + + @doc("Callback that triggers on approval state change.") + @armResourceAction(EnclaveResource) + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @renamedFrom( + Microsoft.Mission.Versions.v2025_05_01_preview, + "approvalCallback" + ) + handleApprovalCreation is ArmResourceActionAsync< + EnclaveResource, + ApprovalCallbackRequest, + ApprovalActionResponse + >; + @doc("Callback that triggers on approval deletion state change.") + @armResourceAction(EnclaveResource) + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @renamedFrom( + Microsoft.Mission.Versions.v2025_05_01_preview, + "approvalDeletionCallback" + ) + handleApprovalDeletion is ArmResourceActionAsync< + EnclaveResource, + ApprovalDeletionCallbackRequest, + ApprovalActionResponse + >; +} + +@doc("Community Interface") +@armResourceOperations +interface Community { + get is ArmResourceRead; + @useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + CommunityResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader & + ArmAsyncOperationHeader + >; + update is ArmCustomPatchAsync< + CommunityResource, + PatchModel = CommunityPatchModel + >; + delete is ArmResourceDeleteWithoutOkAsync; + listByResourceGroup is ArmResourceListByParent; + listBySubscription is ArmListBySubscription; + + @autoRoute + @doc("Checks that the IP Address Space to be allocated for this Community is available.") + @armResourceAction(CommunityResource) + @post + checkAddressSpaceAvailability( + ...ResourceInstanceParameters, + + @doc("Check IP Address Space request body.") + @bodyRoot + checkAddressSpaceAvailabilityRequest: CheckAddressSpaceAvailabilityRequest, + ): ArmResponse | ErrorResponse; +} + +@doc("TransitHub Interface") +@armResourceOperations +interface TransitHub { + get is ArmResourceRead; + @useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + TransitHubResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader & + ArmAsyncOperationHeader + >; + update is ArmCustomPatchAsync< + TransitHubResource, + PatchModel = TransitHubPatchModel + >; + delete is ArmResourceDeleteWithoutOkAsync; + listByCommunityResource is ArmResourceListByParent; + listBySubscription is ArmListBySubscription; +} + +@doc("Enclave Connection Interface") +@armResourceOperations +interface EnclaveConnection { + get is ArmResourceRead; + @useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + EnclaveConnectionResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader & + ArmAsyncOperationHeader + >; + update is ArmCustomPatchAsync< + EnclaveConnectionResource, + PatchModel = EnclaveConnectionPatchModel + >; + delete is ArmResourceDeleteWithoutOkAsync; + listByResourceGroup is ArmResourceListByParent; + listBySubscription is ArmListBySubscription; + + @doc("Callback that triggers on approval state change.") + @armResourceAction(EnclaveConnectionResource) + @renamedFrom( + Microsoft.Mission.Versions.v2025_05_01_preview, + "approvalCallback" + ) + handleApprovalCreation is ArmResourceActionAsync< + EnclaveConnectionResource, + ApprovalCallbackRequest, + ApprovalActionResponse + >; + @doc("Callback that triggers on approval deletion state change.") + @armResourceAction(EnclaveConnectionResource) + @renamedFrom( + Microsoft.Mission.Versions.v2025_05_01_preview, + "approvalDeletionCallback" + ) + handleApprovalDeletion is ArmResourceActionAsync< + EnclaveConnectionResource, + ApprovalDeletionCallbackRequest, + ApprovalActionResponse + >; +} + +@doc("Enclave Endpoint Interface") +@armResourceOperations +interface EnclaveEndpoints { + get is ArmResourceRead; + @useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + EnclaveEndpointResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader & + ArmAsyncOperationHeader + >; + update is ArmCustomPatchAsync< + EnclaveEndpointResource, + PatchModel = EnclaveEndpointPatchModel + >; + delete is ArmResourceDeleteWithoutOkAsync; + listByEnclaveResource is ArmResourceListByParent; + listBySubscription is ArmListBySubscription; + + @doc("Callback that triggers on approval state change.") + @armResourceAction(EnclaveEndpointResource) + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @renamedFrom( + Microsoft.Mission.Versions.v2025_05_01_preview, + "approvalCallback" + ) + handleApprovalCreation is ArmResourceActionAsync< + EnclaveEndpointResource, + ApprovalCallbackRequest, + ApprovalActionResponse + >; + @doc("Callback that triggers on approval deletion state change.") + @armResourceAction(EnclaveEndpointResource) + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @renamedFrom( + Microsoft.Mission.Versions.v2025_05_01_preview, + "approvalDeletionCallback" + ) + handleApprovalDeletion is ArmResourceActionAsync< + EnclaveEndpointResource, + ApprovalDeletionCallbackRequest, + ApprovalActionResponse + >; +} + +@doc("Community Endpoint Interface") +@armResourceOperations +interface CommunityEndpoints { + get is ArmResourceRead; + @useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + CommunityEndpointResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader & + ArmAsyncOperationHeader + >; + update is ArmCustomPatchAsync< + CommunityEndpointResource, + PatchModel = CommunityEndpointPatchModel + >; + delete is ArmResourceDeleteWithoutOkAsync; + listByCommunityResource is ArmResourceListByParent; + listBySubscription is ArmListBySubscription; + + @doc("Callback that triggers on approval state change.") + @armResourceAction(CommunityEndpointResource) + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @renamedFrom( + Microsoft.Mission.Versions.v2025_05_01_preview, + "approvalCallback" + ) + handleApprovalCreation is ArmResourceActionAsync< + CommunityEndpointResource, + ApprovalCallbackRequest, + ApprovalActionResponse + >; + @doc("Callback that triggers on approval deletion state change.") + @armResourceAction(CommunityEndpointResource) + @added(Microsoft.Mission.Versions.v2024_12_01_preview) + @renamedFrom( + Microsoft.Mission.Versions.v2025_05_01_preview, + "approvalDeletionCallback" + ) + handleApprovalDeletion is ArmResourceActionAsync< + CommunityEndpointResource, + ApprovalDeletionCallbackRequest, + ApprovalActionResponse + >; +} + +@doc("Approval Interface") +@armResourceOperations +interface Approval { + get is ArmResourceRead; + @useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + ApprovalResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader & + ArmAsyncOperationHeader + >; + listByParent is ArmResourceListByParent; + update is ArmCustomPatchAsync< + ApprovalResource, + PatchModel = ApprovalPatchModel + >; + delete is ArmResourceDeleteWithoutOkAsync; + @doc("Upon receiving approval or rejection from approver, this facilitates actions on approval resource") + @armResourceAction(ApprovalResource) + @renamedFrom( + Microsoft.Mission.Versions.v2025_05_01_preview, + "initiatorCallback" + ) + notifyInitiator is ArmResourceActionAsync< + ApprovalResource, + ApprovalActionRequest, + ApprovalActionResponse + >; +} diff --git a/specification/mission/Mission.Management/tspconfig.yaml b/specification/mission/Mission.Management/tspconfig.yaml new file mode 100644 index 000000000000..5351a7d2031d --- /dev/null +++ b/specification/mission/Mission.Management/tspconfig.yaml @@ -0,0 +1,51 @@ +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true + emitter-output-dir: "{project-root}/../" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" + arm-types-dir: "{project-root}/../../common-types/resource-management" + omit-unreachable-types: true + use-read-only-status-schema: true + "@azure-tools/typespec-go": + service-dir: sdk/resourcemanager/virtualenclaves #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + package-dir: armvirtualenclaves #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + module: github.com/Azure/azure-sdk-for-go/{service-dir}/{package-dir} #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + fix-const-stuttering: true #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + generate-samples: true #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + generate-fakes: true #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + head-as-boolean: true #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + inject-spans: true #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + flavor: azure #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + "@azure-tools/typespec-python": + package-dir: azure-mgmt-virtualenclaves #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + namespace: azure.mgmt.virtualenclaves #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + generate-test: true #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + generate-sample: true #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + flavor: azure #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + "@azure-tools/typespec-java": + flavor: azure #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + package-dir: azure-resourcemanager-virtualenclaves #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + namespace: com.azure.resourcemanager.virtualenclaves #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + service-name: Virtual Enclaves #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation + "@azure-tools/typespec-ts": + package-dir: "arm-virtualenclaves" + flavor: azure + experimental-extensible-enums: true + package-details: + name: "@azure/arm-virtualenclaves" + "@azure-tools/typespec-csharp": + flavor: azure + package-dir: "Azure.ResourceManager.VirtualEnclaves" + clear-output-folder: true + model-namespace: true + namespace: "{package-dir}" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" +parameters: + service-dir: + default: sdk/virtualenclaves #!!!IMPORTANT!!! To ensure the emitter correctly produces SDK, this configuration is added by Azure SDK Team. Some configurations use placeholder values. For modifications, please refer to https://aka.ms/azsdk/specs/typespec-validation#sdktspconfigvalidation diff --git a/specification/mission/Mission.Management/version.tsp b/specification/mission/Mission.Management/version.tsp new file mode 100644 index 000000000000..a64b4f5ec04d --- /dev/null +++ b/specification/mission/Mission.Management/version.tsp @@ -0,0 +1,30 @@ +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Azure.ResourceManager; +using TypeSpec.Versioning; + +@versioned(Microsoft.Mission.Versions) +@doc("Microsoft Mission Resource Provider management API.") +namespace Microsoft.Mission; + +@doc("Supported API versions for the Microsoft.Mission resource provider.") +enum Versions { + @doc("The 2024-06-01-preview version.") + @armCommonTypesVersion("v5") + @Versioning.useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @Versioning.useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2024_06_01_preview: "2024-06-01-preview", + + @doc("The 2024-12-01-preview version.") + @armCommonTypesVersion("v5") + @Versioning.useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @Versioning.useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2024_12_01_preview: "2024-12-01-preview", + + @doc("The 2025-05-01-preview version.") + @armCommonTypesVersion("v5") + @Versioning.useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @Versioning.useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2025_05_01_preview: "2025-05-01-preview", +} diff --git a/specification/mission/cspell.yaml b/specification/mission/cspell.yaml new file mode 100644 index 000000000000..8884fb3bf09a --- /dev/null +++ b/specification/mission/cspell.yaml @@ -0,0 +1,18 @@ +# This file configures spell checking. Items in "words" were initially populated +# with words that might be spelling errors. Review these words and take +# appropriate action. For more information, see: https://aka.ms/ci-fix#spell-check + +# Spell checking is not case sensitive +# Keep word lists in alphabetical order so the file is easier to manage +import: + - ../../cspell.yaml +words: + - initator + - resourceid + - mobo +overrides: + - filename: >- + **/specification/mission/Mission.Management/resourcetypes/community/community.tsp + words: + - roleassignmentitem + diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_CreateOrUpdate.json new file mode 100644 index 000000000000..1cac517c3506 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_CreateOrUpdate.json @@ -0,0 +1,72 @@ +{ + "title": "Approval_CreateOrUpdate", + "operationId": "Approval_CreateOrUpdate", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-06-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "resource": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved" + } + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved" + } + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_Delete.json new file mode 100644 index 000000000000..611df2fd2015 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "Approval_Delete", + "operationId": "Approval_Delete", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_Get.json new file mode 100644 index 000000000000..b82d8110850b --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_Get.json @@ -0,0 +1,37 @@ +{ + "title": "Approval_Get", + "operationId": "Approval_Get", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved" + } + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_InitiatorCallback.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_InitiatorCallback.json new file mode 100644 index 000000000000..1a4263e628f5 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_InitiatorCallback.json @@ -0,0 +1,28 @@ +{ + "title": "Approval_InitiatorCallback", + "operationId": "Approval_InitiatorCallback", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "body": { + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approved" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_ListByParent.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_ListByParent.json new file mode 100644 index 000000000000..ccc3fec7cd3c --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_ListByParent.json @@ -0,0 +1,42 @@ +{ + "title": "Approval_ListByParent", + "operationId": "Approval_ListByParent", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved" + } + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_Update.json new file mode 100644 index 000000000000..7afa25831ff1 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Approvals_Update.json @@ -0,0 +1,51 @@ +{ + "title": "Approval_Update", + "operationId": "Approval_Update", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-06-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "properties": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved" + } + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_CreateOrUpdate.json new file mode 100644 index 000000000000..e9e453a7e223 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_CreateOrUpdate.json @@ -0,0 +1,101 @@ +{ + "title": "CommunityEndpoints_CreateOrUpdate", + "operationId": "CommunityEndpoints_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "resource": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communties/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_Delete.json new file mode 100644 index 000000000000..bb98bd68dde3 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "CommunityEndpoints_Delete", + "operationId": "CommunityEndpoints_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_Get.json new file mode 100644 index 000000000000..a21229f9fd1a --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_Get.json @@ -0,0 +1,46 @@ +{ + "title": "CommunityEndpoints_Get", + "operationId": "CommunityEndpoints_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_ListByCommunityResource.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_ListByCommunityResource.json new file mode 100644 index 000000000000..0958612bc8af --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_ListByCommunityResource.json @@ -0,0 +1,51 @@ +{ + "title": "CommunityEndpoints_ListByCommunityResource", + "operationId": "CommunityEndpoints_ListByCommunityResource", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_ListBySubscription.json new file mode 100644 index 000000000000..a691f2e19299 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_ListBySubscription.json @@ -0,0 +1,50 @@ +{ + "title": "CommunityEndpoints_ListBySubscription", + "operationId": "CommunityEndpoints_ListBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_Update.json new file mode 100644 index 000000000000..51f8bceaea95 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/CommunityEndpoints_Update.json @@ -0,0 +1,70 @@ +{ + "title": "CommunityEndpoints_Update", + "operationId": "CommunityEndpoints_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_CreateOrUpdate.json new file mode 100644 index 000000000000..3325cfa8b3eb --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_CreateOrUpdate.json @@ -0,0 +1,489 @@ +{ + "title": "Community_CreateOrUpdate", + "operationId": "Community_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "resource": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "governedServiceList": [ + { + "id": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "AppService", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "ContainerRegistry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "KeyVault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "MicrosoftSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "ServiceBus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "AzureFirewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "PrivateDNSZones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "DataConnectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_Delete.json new file mode 100644 index 000000000000..5d5d5416861c --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "Community_Delete", + "operationId": "Community_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_Get.json new file mode 100644 index 000000000000..018c8a26fb58 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_Get.json @@ -0,0 +1,194 @@ +{ + "title": "Community_Get", + "operationId": "Community_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_ListByResourceGroup.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_ListByResourceGroup.json new file mode 100644 index 000000000000..56ad188c2c05 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_ListByResourceGroup.json @@ -0,0 +1,198 @@ +{ + "title": "Community_ListByResourceGroup", + "operationId": "Community_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_ListBySubscription.json new file mode 100644 index 000000000000..04eef7441ba6 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_ListBySubscription.json @@ -0,0 +1,197 @@ +{ + "title": "Community_ListBySubscription", + "operationId": "Community_ListBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_PostCheckAddressSpaceAvailability.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_PostCheckAddressSpaceAvailability.json new file mode 100644 index 000000000000..084f1426588d --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_PostCheckAddressSpaceAvailability.json @@ -0,0 +1,33 @@ +{ + "operationId": "Community_CheckAddressSpaceAvailability", + "title": "Community_CheckAddressSpaceAvailability", + "parameters": { + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "checkAddressSpaceAvailabilityRequest": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + } + }, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": true + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_Update.json new file mode 100644 index 000000000000..46ddf7c6a9ee --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Community_Update.json @@ -0,0 +1,310 @@ +{ + "title": "Community_Update", + "operationId": "Community_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "dnsServers": [ + "azure.net" + ], + "governedServiceList": [ + { + "id": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "AppService", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "ContainerRegistry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "KeyVault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "MicrosoftSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "ServiceBus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "AzureFirewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "PrivateDNSZones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "DataConnectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_ApprovalDeletionCallback.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_ApprovalDeletionCallback.json new file mode 100644 index 000000000000..278ef0d9a686 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_ApprovalDeletionCallback.json @@ -0,0 +1,27 @@ +{ + "operationId": "EnclaveConnection_ApprovalDeletionCallback", + "title": "EnclaveConnection_ApprovalDeletionCallback", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_CreateOrUpdate.json new file mode 100644 index 000000000000..94258eed37c2 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_CreateOrUpdate.json @@ -0,0 +1,79 @@ +{ + "title": "EnclaveConnection_CreateOrUpdate", + "operationId": "EnclaveConnection_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "resource": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_Delete.json new file mode 100644 index 000000000000..84af8ab84f38 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "EnclaveConnection_Delete", + "operationId": "EnclaveConnection_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_Get.json new file mode 100644 index 000000000000..3fa04ce12bf2 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_Get.json @@ -0,0 +1,38 @@ +{ + "title": "EnclaveConnection_Get", + "operationId": "EnclaveConnection_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_ListByResourceGroup.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_ListByResourceGroup.json new file mode 100644 index 000000000000..6e181e4f0e9a --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_ListByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "title": "EnclaveConnection_ListByResourceGroup", + "operationId": "EnclaveConnection_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_ListBySubscription.json new file mode 100644 index 000000000000..baead581952a --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_ListBySubscription.json @@ -0,0 +1,42 @@ +{ + "title": "EnclaveConnection_ListBySubscription", + "operationId": "EnclaveConnection_ListBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_PostApprovalCallback.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_PostApprovalCallback.json new file mode 100644 index 000000000000..206bb94c0561 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_PostApprovalCallback.json @@ -0,0 +1,29 @@ +{ + "operationId": "EnclaveConnection_ApprovalCallback", + "title": "EnclaveConnection_ApprovalCallback", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "resourceRequestAction": "Create", + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_Update.json new file mode 100644 index 000000000000..4ec018978564 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveConnection_Update.json @@ -0,0 +1,52 @@ +{ + "title": "EnclaveConnection_Update", + "operationId": "EnclaveConnection_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "sourceCidr": "10.0.0.0/24" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_CreateOrUpdate.json new file mode 100644 index 000000000000..81a6c1647393 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_CreateOrUpdate.json @@ -0,0 +1,98 @@ +{ + "title": "EnclaveEndpoints_CreateOrUpdate", + "operationId": "EnclaveEndpoints_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "resource": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_Delete.json new file mode 100644 index 000000000000..7113940e5bfc --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "EnclaveEndpoints_Delete", + "operationId": "EnclaveEndpoints_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_Get.json new file mode 100644 index 000000000000..4bf0a2d69eb8 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_Get.json @@ -0,0 +1,45 @@ +{ + "title": "EnclaveEndpoints_Get", + "operationId": "EnclaveEndpoints_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint" + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_ListByEnclaveResource.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_ListByEnclaveResource.json new file mode 100644 index 000000000000..ffcf98d6bdf3 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_ListByEnclaveResource.json @@ -0,0 +1,49 @@ +{ + "title": "EnclaveEndpoints_ListByEnclaveResource", + "operationId": "EnclaveEndpoints_ListByEnclaveResource", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_ListBySubscription.json new file mode 100644 index 000000000000..1bf13598e8f4 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "title": "EnclaveEndpoints_ListBySubscription", + "operationId": "EnclaveEndpoints_ListBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_Update.json new file mode 100644 index 000000000000..c6ce3b60dd82 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/EnclaveEndpoints_Update.json @@ -0,0 +1,68 @@ +{ + "title": "EnclaveEndpoints_Update", + "operationId": "EnclaveEndpoints_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Operations_List.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..72de8204210a --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Operations_List.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "kribdpoznbvrjci", + "isDataAction": true, + "display": { + "provider": "usvnnruysydqdpwj", + "resource": "lrdjzltcbeoljosqrw", + "operation": "vdnitexr", + "description": "valid description goes here" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_CreateOrUpdate.json new file mode 100644 index 000000000000..b151e4c32f79 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_CreateOrUpdate.json @@ -0,0 +1,95 @@ +{ + "title": "TransitHub_CreateOrUpdate", + "operationId": "TransitHub_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName", + "resource": { + "properties": { + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + } + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "zwwdhidevngwzo", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_Delete.json new file mode 100644 index 000000000000..cb7056404587 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "TransitHub_Delete", + "operationId": "TransitHub_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_Get.json new file mode 100644 index 000000000000..9bf51dd8fded --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_Get.json @@ -0,0 +1,45 @@ +{ + "title": "TransitHub_Get", + "operationId": "TransitHub_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_ListByCommunityResource.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_ListByCommunityResource.json new file mode 100644 index 000000000000..316af739cb68 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_ListByCommunityResource.json @@ -0,0 +1,49 @@ +{ + "title": "TransitHub_ListByCommunityResource", + "operationId": "TransitHub_ListByCommunityResource", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithub", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_ListBySubscription.json new file mode 100644 index 000000000000..23a168cb6545 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "title": "TransitHub_ListBySubscription", + "operationId": "TransitHub_ListBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_Update.json new file mode 100644 index 000000000000..d37792c938c9 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/TransitHub_Update.json @@ -0,0 +1,65 @@ +{ + "title": "TransitHub_Update", + "operationId": "TransitHub_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName", + "location": "westcentralus", + "properties": { + "tags": { + "key4278": "hjoxhwofxcshowbnafdrrzq" + }, + "properties": { + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_CreateOrUpdate.json new file mode 100644 index 000000000000..5ea87437aa5c --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_CreateOrUpdate.json @@ -0,0 +1,190 @@ +{ + "title": "VirtualEnclave_CreateOrUpdate", + "operationId": "VirtualEnclave_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "resource": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "diagnosticDestination": "Both" + }, + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_Delete.json new file mode 100644 index 000000000000..b8b1e797b847 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "VirtualEnclave_Delete", + "operationId": "VirtualEnclave_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_Get.json new file mode 100644 index 000000000000..0ce7acdc21e5 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_Get.json @@ -0,0 +1,85 @@ +{ + "title": "VirtualEnclave_Get", + "operationId": "VirtualEnclave_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_ListByResourceGroup.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_ListByResourceGroup.json new file mode 100644 index 000000000000..386cbdbe6616 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_ListByResourceGroup.json @@ -0,0 +1,89 @@ +{ + "title": "VirtualEnclave_ListByResourceGroup", + "operationId": "VirtualEnclave_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_ListBySubscription.json new file mode 100644 index 000000000000..d0035fc2ac05 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_ListBySubscription.json @@ -0,0 +1,88 @@ +{ + "title": "VirtualEnclave_ListBySubscription", + "operationId": "VirtualEnclave_ListBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_Update.json new file mode 100644 index 000000000000..e644bb524861 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/VirtualEnclave_Update.json @@ -0,0 +1,128 @@ +{ + "title": "VirtualEnclave_Update", + "operationId": "VirtualEnclave_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "westcentralus", + "properties": { + "tags": { + "Tag1": "Value1" + }, + "properties": { + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "enclaveDefaultSettings": { + "diagnosticDestination": "Both" + }, + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_CreateOrUpdate.json new file mode 100644 index 000000000000..0a5a0d9aa633 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_CreateOrUpdate.json @@ -0,0 +1,71 @@ +{ + "title": "Workload_CreateOrUpdate", + "operationId": "Workload_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload", + "resource": { + "properties": { + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_Delete.json new file mode 100644 index 000000000000..31d0354f3ba7 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "Workload_Delete", + "operationId": "Workload_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_Get.json new file mode 100644 index 000000000000..4ec1e7854f23 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_Get.json @@ -0,0 +1,38 @@ +{ + "title": "Workload_Get", + "operationId": "Workload_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_ListByEnclaveResource.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_ListByEnclaveResource.json new file mode 100644 index 000000000000..1d4f9bc83d45 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_ListByEnclaveResource.json @@ -0,0 +1,42 @@ +{ + "title": "Workload_ListByEnclaveResource", + "operationId": "Workload_ListByEnclaveResource", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_ListBySubscription.json new file mode 100644 index 000000000000..e3895932704e --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "title": "Workload_ListBySubscription", + "operationId": "Workload_ListBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_Update.json new file mode 100644 index 000000000000..2075250e1ef2 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/examples/Workload_Update.json @@ -0,0 +1,54 @@ +{ + "title": "Workload_Update", + "operationId": "Workload_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload", + "location": "westcentralus", + "properties": { + "tags": { + "key9465": "cylmdprdhhwpcdxpynwostvzytkryj" + }, + "properties": { + "resourceGroupCollection": [ + "g" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/openapi.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/openapi.json new file mode 100644 index 000000000000..38792fac13e5 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-06-01-preview/openapi.json @@ -0,0 +1,5380 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Mission", + "version": "2024-06-01-preview", + "description": "Microsoft Mission Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Workload" + }, + { + "name": "VirtualEnclave" + }, + { + "name": "Community" + }, + { + "name": "TransitHub" + }, + { + "name": "EnclaveConnection" + }, + { + "name": "EnclaveEndpoints" + }, + { + "name": "CommunityEndpoints" + }, + { + "name": "Approval" + } + ], + "paths": { + "/{resourceUri}/providers/Microsoft.Mission/approvals": { + "get": { + "operationId": "Approval_ListByParent", + "tags": [ + "Approval" + ], + "description": "List ApprovalResource resources by parent", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_ListByParent": { + "$ref": "./examples/Approvals_ListByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.Mission/approvals/{approvalName}": { + "get": { + "operationId": "Approval_Get", + "tags": [ + "Approval" + ], + "description": "Get a ApprovalResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "approvalName", + "in": "path", + "description": "The name of the approvals resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_Get": { + "$ref": "./examples/Approvals_Get.json" + } + } + }, + "put": { + "operationId": "Approval_CreateOrUpdate", + "tags": [ + "Approval" + ], + "description": "Create a ApprovalResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "approvalName", + "in": "path", + "description": "The name of the approvals resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ApprovalResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/ApprovalResource" + } + }, + "201": { + "description": "Resource 'ApprovalResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/ApprovalResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_CreateOrUpdate": { + "$ref": "./examples/Approvals_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Approval_Update", + "tags": [ + "Approval" + ], + "description": "Update a ApprovalResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "approvalName", + "in": "path", + "description": "The name of the approvals resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_Update": { + "$ref": "./examples/Approvals_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Approval_Delete", + "tags": [ + "Approval" + ], + "description": "Delete a ApprovalResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "approvalName", + "in": "path", + "description": "The name of the approvals resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_Delete": { + "$ref": "./examples/Approvals_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.Mission/approvals/{approvalName}/initiatorCallback": { + "post": { + "operationId": "Approval_InitiatorCallback", + "tags": [ + "Approval" + ], + "description": "Upon receiving approval or rejection from approver, this facilitates actions on approval resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "approvalName", + "in": "path", + "description": "The name of the approvals resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalActionRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_InitiatorCallback": { + "$ref": "./examples/Approvals_InitiatorCallback.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.Mission/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/communities": { + "get": { + "operationId": "Community_ListBySubscription", + "tags": [ + "Community" + ], + "description": "List CommunityResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_ListBySubscription": { + "$ref": "./examples/Community_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints": { + "get": { + "operationId": "CommunityEndpoints_ListBySubscription", + "tags": [ + "CommunityEndpoints" + ], + "description": "List CommunityEndpointResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityEndpointResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_ListBySubscription": { + "$ref": "./examples/CommunityEndpoints_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/communities/{communityName}/transitHubs": { + "get": { + "operationId": "TransitHub_ListBySubscription", + "tags": [ + "TransitHub" + ], + "description": "List TransitHubResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TransitHubResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_ListBySubscription": { + "$ref": "./examples/TransitHub_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/enclaveConnections": { + "get": { + "operationId": "EnclaveConnection_ListBySubscription", + "tags": [ + "EnclaveConnection" + ], + "description": "List EnclaveConnectionResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_ListBySubscription": { + "$ref": "./examples/EnclaveConnection_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/virtualEnclaves": { + "get": { + "operationId": "VirtualEnclave_ListBySubscription", + "tags": [ + "VirtualEnclave" + ], + "description": "List EnclaveResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_ListBySubscription": { + "$ref": "./examples/VirtualEnclave_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints": { + "get": { + "operationId": "EnclaveEndpoints_ListBySubscription", + "tags": [ + "EnclaveEndpoints" + ], + "description": "List EnclaveEndpointResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_ListBySubscription": { + "$ref": "./examples/EnclaveEndpoints_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/workloads": { + "get": { + "operationId": "Workload_ListBySubscription", + "tags": [ + "Workload" + ], + "description": "List WorkloadResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_ListBySubscription": { + "$ref": "./examples/Workload_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities": { + "get": { + "operationId": "Community_ListByResourceGroup", + "tags": [ + "Community" + ], + "description": "List CommunityResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_ListByResourceGroup": { + "$ref": "./examples/Community_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}": { + "get": { + "operationId": "Community_Get", + "tags": [ + "Community" + ], + "description": "Get a CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_Get": { + "$ref": "./examples/Community_Get.json" + } + } + }, + "put": { + "operationId": "Community_CreateOrUpdate", + "tags": [ + "Community" + ], + "description": "Create a CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunityResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CommunityResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/CommunityResource" + } + }, + "201": { + "description": "Resource 'CommunityResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/CommunityResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_CreateOrUpdate": { + "$ref": "./examples/Community_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Community_Update", + "tags": [ + "Community" + ], + "description": "Update a CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunityPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_Update": { + "$ref": "./examples/Community_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Community_Delete", + "tags": [ + "Community" + ], + "description": "Delete a CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_Delete": { + "$ref": "./examples/Community_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/checkAddressSpaceAvailability": { + "post": { + "operationId": "Community_CheckAddressSpaceAvailability", + "tags": [ + "Community" + ], + "description": "Checks that the IP Address Space to be allocated for this Community is available.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "checkAddressSpaceAvailabilityRequest", + "in": "body", + "description": "Check IP Address Space request body.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckAddressSpaceAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CheckAddressSpaceAvailabilityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_CheckAddressSpaceAvailability": { + "$ref": "./examples/Community_PostCheckAddressSpaceAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints": { + "get": { + "operationId": "CommunityEndpoints_ListByCommunityResource", + "tags": [ + "CommunityEndpoints" + ], + "description": "List CommunityEndpointResource resources by CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityEndpointResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_ListByCommunityResource": { + "$ref": "./examples/CommunityEndpoints_ListByCommunityResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints/{communityEndpointName}": { + "get": { + "operationId": "CommunityEndpoints_Get", + "tags": [ + "CommunityEndpoints" + ], + "description": "Get a CommunityEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "communityEndpointName", + "in": "path", + "description": "The name of the Community Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityEndpointResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_Get": { + "$ref": "./examples/CommunityEndpoints_Get.json" + } + } + }, + "put": { + "operationId": "CommunityEndpoints_CreateOrUpdate", + "tags": [ + "CommunityEndpoints" + ], + "description": "Create a CommunityEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "communityEndpointName", + "in": "path", + "description": "The name of the Community Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunityEndpointResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CommunityEndpointResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/CommunityEndpointResource" + } + }, + "201": { + "description": "Resource 'CommunityEndpointResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/CommunityEndpointResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_CreateOrUpdate": { + "$ref": "./examples/CommunityEndpoints_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CommunityEndpoints_Update", + "tags": [ + "CommunityEndpoints" + ], + "description": "Update a CommunityEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "communityEndpointName", + "in": "path", + "description": "The name of the Community Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunityEndpointPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityEndpointResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_Update": { + "$ref": "./examples/CommunityEndpoints_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CommunityEndpoints_Delete", + "tags": [ + "CommunityEndpoints" + ], + "description": "Delete a CommunityEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "communityEndpointName", + "in": "path", + "description": "The name of the Community Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_Delete": { + "$ref": "./examples/CommunityEndpoints_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/transitHubs": { + "get": { + "operationId": "TransitHub_ListByCommunityResource", + "tags": [ + "TransitHub" + ], + "description": "List TransitHubResource resources by CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TransitHubResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_ListByCommunityResource": { + "$ref": "./examples/TransitHub_ListByCommunityResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/transitHubs/{transitHubName}": { + "get": { + "operationId": "TransitHub_Get", + "tags": [ + "TransitHub" + ], + "description": "Get a TransitHubResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "transitHubName", + "in": "path", + "description": "The name of the TransitHub Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TransitHubResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_Get": { + "$ref": "./examples/TransitHub_Get.json" + } + } + }, + "put": { + "operationId": "TransitHub_CreateOrUpdate", + "tags": [ + "TransitHub" + ], + "description": "Create a TransitHubResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "transitHubName", + "in": "path", + "description": "The name of the TransitHub Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TransitHubResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'TransitHubResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/TransitHubResource" + } + }, + "201": { + "description": "Resource 'TransitHubResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/TransitHubResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_CreateOrUpdate": { + "$ref": "./examples/TransitHub_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "TransitHub_Update", + "tags": [ + "TransitHub" + ], + "description": "Update a TransitHubResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "transitHubName", + "in": "path", + "description": "The name of the TransitHub Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/TransitHubPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TransitHubResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_Update": { + "$ref": "./examples/TransitHub_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "TransitHub_Delete", + "tags": [ + "TransitHub" + ], + "description": "Delete a TransitHubResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "transitHubName", + "in": "path", + "description": "The name of the TransitHub Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_Delete": { + "$ref": "./examples/TransitHub_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections": { + "get": { + "operationId": "EnclaveConnection_ListByResourceGroup", + "tags": [ + "EnclaveConnection" + ], + "description": "List EnclaveConnectionResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_ListByResourceGroup": { + "$ref": "./examples/EnclaveConnection_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections/{enclaveConnectionName}": { + "get": { + "operationId": "EnclaveConnection_Get", + "tags": [ + "EnclaveConnection" + ], + "description": "Get a EnclaveConnectionResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_Get": { + "$ref": "./examples/EnclaveConnection_Get.json" + } + } + }, + "put": { + "operationId": "EnclaveConnection_CreateOrUpdate", + "tags": [ + "EnclaveConnection" + ], + "description": "Create a EnclaveConnectionResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EnclaveConnectionResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EnclaveConnectionResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResource" + } + }, + "201": { + "description": "Resource 'EnclaveConnectionResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_CreateOrUpdate": { + "$ref": "./examples/EnclaveConnection_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EnclaveConnection_Update", + "tags": [ + "EnclaveConnection" + ], + "description": "Update a EnclaveConnectionResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EnclaveConnectionPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_Update": { + "$ref": "./examples/EnclaveConnection_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EnclaveConnection_Delete", + "tags": [ + "EnclaveConnection" + ], + "description": "Delete a EnclaveConnectionResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_Delete": { + "$ref": "./examples/EnclaveConnection_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections/{enclaveConnectionName}/approvalCallback": { + "post": { + "operationId": "EnclaveConnection_ApprovalCallback", + "tags": [ + "EnclaveConnection" + ], + "description": "Callback that triggers on approval state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_ApprovalCallback": { + "$ref": "./examples/EnclaveConnection_PostApprovalCallback.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections/{enclaveConnectionName}/approvalDeletionCallback": { + "post": { + "operationId": "EnclaveConnection_ApprovalDeletionCallback", + "tags": [ + "EnclaveConnection" + ], + "description": "Callback that triggers on approval deletion state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalDeletionCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_ApprovalDeletionCallback": { + "$ref": "./examples/EnclaveConnection_ApprovalDeletionCallback.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves": { + "get": { + "operationId": "VirtualEnclave_ListByResourceGroup", + "tags": [ + "VirtualEnclave" + ], + "description": "List EnclaveResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_ListByResourceGroup": { + "$ref": "./examples/VirtualEnclave_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}": { + "get": { + "operationId": "VirtualEnclave_Get", + "tags": [ + "VirtualEnclave" + ], + "description": "Get a EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_Get": { + "$ref": "./examples/VirtualEnclave_Get.json" + } + } + }, + "put": { + "operationId": "VirtualEnclave_CreateOrUpdate", + "tags": [ + "VirtualEnclave" + ], + "description": "Create a EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EnclaveResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EnclaveResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveResource" + } + }, + "201": { + "description": "Resource 'EnclaveResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_CreateOrUpdate": { + "$ref": "./examples/VirtualEnclave_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VirtualEnclave_Update", + "tags": [ + "VirtualEnclave" + ], + "description": "Update a EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualEnclavePatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_Update": { + "$ref": "./examples/VirtualEnclave_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualEnclave_Delete", + "tags": [ + "VirtualEnclave" + ], + "description": "Delete a EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_Delete": { + "$ref": "./examples/VirtualEnclave_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints": { + "get": { + "operationId": "EnclaveEndpoints_ListByEnclaveResource", + "tags": [ + "EnclaveEndpoints" + ], + "description": "List EnclaveEndpointResource resources by EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_ListByEnclaveResource": { + "$ref": "./examples/EnclaveEndpoints_ListByEnclaveResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints/{enclaveEndpointName}": { + "get": { + "operationId": "EnclaveEndpoints_Get", + "tags": [ + "EnclaveEndpoints" + ], + "description": "Get a EnclaveEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "enclaveEndpointName", + "in": "path", + "description": "The name of the Enclave Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_Get": { + "$ref": "./examples/EnclaveEndpoints_Get.json" + } + } + }, + "put": { + "operationId": "EnclaveEndpoints_CreateOrUpdate", + "tags": [ + "EnclaveEndpoints" + ], + "description": "Create a EnclaveEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "enclaveEndpointName", + "in": "path", + "description": "The name of the Enclave Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EnclaveEndpointResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EnclaveEndpointResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResource" + } + }, + "201": { + "description": "Resource 'EnclaveEndpointResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_CreateOrUpdate": { + "$ref": "./examples/EnclaveEndpoints_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EnclaveEndpoints_Update", + "tags": [ + "EnclaveEndpoints" + ], + "description": "Update a EnclaveEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "enclaveEndpointName", + "in": "path", + "description": "The name of the Enclave Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EnclaveEndpointPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_Update": { + "$ref": "./examples/EnclaveEndpoints_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EnclaveEndpoints_Delete", + "tags": [ + "EnclaveEndpoints" + ], + "description": "Delete a EnclaveEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "enclaveEndpointName", + "in": "path", + "description": "The name of the Enclave Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_Delete": { + "$ref": "./examples/EnclaveEndpoints_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/workloads": { + "get": { + "operationId": "Workload_ListByEnclaveResource", + "tags": [ + "Workload" + ], + "description": "List WorkloadResource resources by EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_ListByEnclaveResource": { + "$ref": "./examples/Workload_ListByEnclaveResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/workloads/{workloadName}": { + "get": { + "operationId": "Workload_Get", + "tags": [ + "Workload" + ], + "description": "Get a WorkloadResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "workloadName", + "in": "path", + "description": "The name of the workloadResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_Get": { + "$ref": "./examples/Workload_Get.json" + } + } + }, + "put": { + "operationId": "Workload_CreateOrUpdate", + "tags": [ + "Workload" + ], + "description": "Create a WorkloadResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "workloadName", + "in": "path", + "description": "The name of the workloadResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'WorkloadResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadResource" + } + }, + "201": { + "description": "Resource 'WorkloadResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_CreateOrUpdate": { + "$ref": "./examples/Workload_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Workload_Update", + "tags": [ + "Workload" + ], + "description": "Update a WorkloadResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "workloadName", + "in": "path", + "description": "The name of the workloadResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_Update": { + "$ref": "./examples/Workload_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Workload_Delete", + "tags": [ + "Workload" + ], + "description": "Delete a WorkloadResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "workloadName", + "in": "path", + "description": "The name of the workloadResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_Delete": { + "$ref": "./examples/Workload_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ApprovalActionRequest": { + "type": "object", + "description": "Request body for calling post-action", + "properties": { + "approvalStatus": { + "type": "string", + "description": "Approval status indicating 'Approved' or 'Rejected'", + "enum": [ + "Approved", + "Rejected" + ], + "x-ms-enum": { + "modelAsString": true + } + } + }, + "required": [ + "approvalStatus" + ] + }, + "ApprovalActionResponse": { + "type": "object", + "description": "Response body after handling of approvalCallbackRequest", + "properties": { + "message": { + "type": "string", + "description": "Confirmation message indicating the result of the operation." + } + }, + "required": [ + "message" + ] + }, + "ApprovalCallbackRequest": { + "type": "object", + "description": "Request body for calling post-action", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "description": "Resource Id of the item being approved or rejected" + }, + "resourceRequestAction": { + "type": "string", + "description": "Resource request action indicating action which needed to be performed upon calling approval-callback post action", + "enum": [ + "Create", + "Delete", + "Update", + "Reset" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "approvalStatus": { + "type": "string", + "description": "Approval status indicating 'Approved' or 'Rejected'", + "enum": [ + "Approved", + "Rejected" + ], + "x-ms-enum": { + "modelAsString": true + } + } + }, + "required": [ + "resourceId", + "resourceRequestAction", + "approvalStatus" + ] + }, + "ApprovalDeletionCallbackRequest": { + "type": "object", + "description": "Request body for calling post-action", + "properties": { + "resourceRequestAction": { + "type": "string", + "description": "Resource request action indicating action which needed to be performed upon calling approval-deletion-callback post action", + "enum": [ + "Create", + "Delete", + "Update" + ], + "x-ms-enum": { + "modelAsString": true + } + } + }, + "required": [ + "resourceRequestAction" + ] + }, + "ApprovalPatchModel": { + "type": "object", + "description": "Approvals patch model.", + "properties": { + "properties": { + "$ref": "#/definitions/ApprovalPatchProperties", + "description": "Approval Patch properties" + } + } + }, + "ApprovalPatchProperties": { + "type": "object", + "description": "Approvals patch properties.", + "properties": { + "parent1": { + "type": "string", + "description": "Parameter for optimizing query results" + }, + "parent2": { + "type": "string", + "description": "Parameter for optimizing query results" + }, + "requestMetadata": { + "$ref": "#/definitions/RequestMetadataUpdatableProperties", + "description": "Request metadata for the approval request." + } + } + }, + "ApprovalProperties": { + "type": "object", + "description": "Approval Base model.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + }, + "parent1": { + "type": "string", + "description": "Parameter for optimizing query results" + }, + "parent2": { + "type": "string", + "description": "Parameter for optimizing query results" + }, + "requestMetadata": { + "$ref": "#/definitions/RequestMetadata", + "description": "Request metadata for the approval request." + } + }, + "required": [ + "requestMetadata" + ] + }, + "ApprovalResource": { + "type": "object", + "description": "Approval Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/ApprovalProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ApprovalResourceListResult": { + "type": "object", + "description": "The response of a ApprovalResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ApprovalResource items on this page", + "items": { + "$ref": "#/definitions/ApprovalResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ApprovalStatus": { + "type": "string", + "description": "Approval Status. It can be Approved, Rejected, Pending, Deleted or Expired.", + "enum": [ + "Approved", + "Rejected", + "Pending" + ], + "x-ms-enum": { + "name": "ApprovalStatus", + "modelAsString": true, + "values": [ + { + "name": "Approved", + "value": "Approved", + "description": "ApprovalStatus Type Approved" + }, + { + "name": "Rejected", + "value": "Rejected", + "description": "ApprovalStatus Type Rejected" + }, + { + "name": "Pending", + "value": "Pending", + "description": "ApprovalStatus Type Pending" + } + ] + } + }, + "Azure.Core.azureLocation": { + "type": "string", + "description": "Represents an Azure geography region where supported resource providers live." + }, + "Azure.ResourceManager.CommonTypes.ManagedServiceIdentityUpdate": { + "type": "object", + "description": "Managed service identity (system assigned and/or user assigned identities)", + "properties": { + "type": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentityType", + "description": "The type of managed identity assigned to this resource." + }, + "userAssignedIdentities": { + "type": "object", + "description": "The identities assigned to this resource by the user.", + "additionalProperties": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentity", + "x-nullable": true + } + } + } + }, + "CheckAddressSpaceAvailabilityRequest": { + "type": "object", + "description": "Request to the action call to check address space availability.", + "properties": { + "communityResourceId": { + "$ref": "#/definitions/CommunityResourceId", + "description": "Resource Id of the Community" + }, + "enclaveVirtualNetwork": { + "$ref": "#/definitions/EnclaveVirtualNetworkModel", + "description": "Information about the enclave virtual network" + } + }, + "required": [ + "communityResourceId", + "enclaveVirtualNetwork" + ] + }, + "CheckAddressSpaceAvailabilityResponse": { + "type": "object", + "description": "Response of availability of the requested address space.", + "properties": { + "value": { + "type": "boolean", + "description": "Boolean representing whether the address space is available." + } + }, + "required": [ + "value" + ] + }, + "CommunityEndpointDestinationRule": { + "type": "object", + "description": "Base type for destination rules.", + "properties": { + "destinationType": { + "$ref": "#/definitions/DestinationType", + "description": "Destination Type." + }, + "protocols": { + "type": "array", + "description": "Protocols. Options specified by Endpoint Protocol Enum.", + "items": { + "$ref": "#/definitions/CommunityEndpointProtocol" + } + }, + "transitHubResourceId": { + "$ref": "#/definitions/TransitHubResourceId", + "description": "Transit Hub Resource Id." + }, + "name": { + "type": "string", + "description": "Endpoint Rule Name." + }, + "destination": { + "type": "string", + "description": "Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas." + }, + "port": { + "type": "string", + "description": "Port. Can include multiple ports separated by commas or a range indicated by a hyphen." + } + } + }, + "CommunityEndpointPatchModel": { + "type": "object", + "description": "Community Endpoint Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/CommunityEndpointPatchProperties", + "description": "Community Endpoint Patch properties" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CommunityEndpointPatchProperties": { + "type": "object", + "description": "Community Endpoint patchable Properties", + "properties": { + "ruleCollection": { + "type": "array", + "description": "Community Endpoint Rule Collection.", + "items": { + "$ref": "#/definitions/CommunityEndpointDestinationRule" + }, + "x-ms-identifiers": [] + }, + "approvalRequired": { + "type": "boolean", + "description": "Whether approval is needed for the connection (True or False)." + } + } + }, + "CommunityEndpointProperties": { + "type": "object", + "description": "Community Endpoint Resource properties", + "properties": { + "ruleCollection": { + "type": "array", + "description": "Community Endpoint Rule Collection.", + "items": { + "$ref": "#/definitions/CommunityEndpointDestinationRule" + }, + "x-ms-identifiers": [] + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids created by community endpoint.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + }, + "approvalRequired": { + "type": "boolean", + "description": "Whether approval is needed for the connection (True or False)." + } + }, + "required": [ + "ruleCollection" + ] + }, + "CommunityEndpointProtocol": { + "type": "string", + "description": "Community Endpoint Protocol Enum", + "enum": [ + "ANY", + "TCP", + "UDP", + "ICMP", + "ESP", + "AH", + "HTTPS", + "HTTP" + ], + "x-ms-enum": { + "name": "CommunityEndpointProtocol", + "modelAsString": true, + "values": [ + { + "name": "ANY", + "value": "ANY", + "description": "CommunityEndpointProtocol Type ANY" + }, + { + "name": "TCP", + "value": "TCP", + "description": "CommunityEndpointProtocol Type TCP" + }, + { + "name": "UDP", + "value": "UDP", + "description": "CommunityEndpointProtocol Type UDP" + }, + { + "name": "ICMP", + "value": "ICMP", + "description": "CommunityEndpointProtocol Type ICMP" + }, + { + "name": "ESP", + "value": "ESP", + "description": "CommunityEndpointProtocol Type ESP" + }, + { + "name": "AH", + "value": "AH", + "description": "CommunityEndpointProtocol Type AH" + }, + { + "name": "HTTPS", + "value": "HTTPS", + "description": "CommunityEndpointProtocol Type HTTPS" + }, + { + "name": "HTTP", + "value": "HTTP", + "description": "CommunityEndpointProtocol Type HTTP" + } + ] + } + }, + "CommunityEndpointResource": { + "type": "object", + "description": "CommunityEndpoint Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/CommunityEndpointProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CommunityEndpointResourceListResult": { + "type": "object", + "description": "The response of a CommunityEndpointResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CommunityEndpointResource items on this page", + "items": { + "$ref": "#/definitions/CommunityEndpointResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CommunityPatchModel": { + "type": "object", + "description": "Community Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/CommunityPatchProperties", + "description": "Community Patch properties" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.ManagedServiceIdentityUpdate", + "description": "The managed service identities assigned to this resource." + } + } + }, + "CommunityPatchProperties": { + "type": "object", + "description": "Community Resource Properties without default values", + "properties": { + "dnsServers": { + "type": "array", + "description": "DNS Servers.", + "items": { + "type": "string" + } + }, + "governedServiceList": { + "type": "array", + "description": "List of services governed by a community.", + "items": { + "$ref": "#/definitions/GovernedServiceItem" + }, + "x-ms-identifiers": [] + } + } + }, + "CommunityProperties": { + "type": "object", + "description": "Community Resource Properties", + "properties": { + "addressSpace": { + "type": "string", + "description": "Address Space.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dnsServers": { + "type": "array", + "description": "DNS Servers.", + "items": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids created by communities.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "managedResourceGroupConfiguration": { + "$ref": "#/definitions/ManagedResourceGroupConfiguration", + "description": "Managed resource group name.", + "readOnly": true + }, + "governedServiceList": { + "type": "array", + "description": "List of services governed by a community.", + "items": { + "$ref": "#/definitions/GovernedServiceItem" + }, + "x-ms-identifiers": [] + } + } + }, + "CommunityResource": { + "type": "object", + "description": "Community Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/CommunityProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CommunityResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Mission/communities" + } + ] + } + }, + "CommunityResourceListResult": { + "type": "object", + "description": "The response of a CommunityResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CommunityResource items on this page", + "items": { + "$ref": "#/definitions/CommunityResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DestinationEndpointResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Mission/virtualEnclaves/enclaveEndpoints" + }, + { + "type": "Microsoft.Mission/communities/communityEndpoints" + } + ] + } + }, + "DestinationType": { + "type": "string", + "description": "Destination Type Enum", + "enum": [ + "FQDN", + "FQDNTag", + "IPAddress", + "PrivateNetwork" + ], + "x-ms-enum": { + "name": "DestinationType", + "modelAsString": true, + "values": [ + { + "name": "FQDN", + "value": "FQDN", + "description": "DestinationType Type FQDN" + }, + { + "name": "FQDNTag", + "value": "FQDNTag", + "description": "DestinationType Type FQDNTag" + }, + { + "name": "IPAddress", + "value": "IPAddress", + "description": "DestinationType Type IPAddress" + }, + { + "name": "PrivateNetwork", + "value": "PrivateNetwork", + "description": "DestinationType Type PrivateNetwork" + } + ] + } + }, + "DiagnosticDestination": { + "type": "string", + "description": "Specifies the destination of where to store diagnostic logs.", + "enum": [ + "CommunityOnly", + "EnclaveOnly", + "Both" + ], + "x-ms-enum": { + "name": "DiagnosticDestination", + "modelAsString": true, + "values": [ + { + "name": "CommunityOnly", + "value": "CommunityOnly", + "description": "DiagnosticDestination Type CommunityOnly" + }, + { + "name": "EnclaveOnly", + "value": "EnclaveOnly", + "description": "DiagnosticDestination Type EnclaveOnly" + }, + { + "name": "Both", + "value": "Both", + "description": "DiagnosticDestination Type Both" + } + ] + } + }, + "EnclaveAddressSpacesModel": { + "type": "object", + "description": "Enclave Address Spaces", + "properties": { + "enclaveAddressSpace": { + "type": "string", + "description": "Enclave Address Space" + }, + "managedAddressSpace": { + "type": "string", + "description": "Managed Address Space" + } + } + }, + "EnclaveConnectionPatchModel": { + "type": "object", + "description": "Enclave Connection Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/EnclaveConnectionPatchProperties", + "description": "Enclave Connection Patch properties" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "EnclaveConnectionPatchProperties": { + "type": "object", + "description": "Enclave Connection patchable Properties", + "properties": { + "sourceCidr": { + "type": "string", + "description": "Source CIDR." + } + } + }, + "EnclaveConnectionProperties": { + "type": "object", + "description": "Enclave Connection Resource properties", + "properties": { + "state": { + "$ref": "#/definitions/EnclaveConnectionState", + "description": "The state of the enclaveConnection.", + "readOnly": true + }, + "communityResourceId": { + "$ref": "#/definitions/CommunityResourceId", + "description": "Community Resource Id.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sourceResourceId": { + "$ref": "#/definitions/EnclaveConnectionSourceResourceId", + "description": "Source Resource Id.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sourceCidr": { + "type": "string", + "description": "Source CIDR." + }, + "ipGroup": { + "$ref": "#/definitions/IPGroupResourceId", + "description": "Source IP group Resource Id.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "destinationEndpointId": { + "$ref": "#/definitions/DestinationEndpointResourceId", + "description": "Destination Endpoint Resource Id.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids modified by enclave Connections.", + "items": { + "type": "string" + }, + "readOnly": true + } + }, + "required": [ + "communityResourceId", + "sourceResourceId", + "destinationEndpointId" + ] + }, + "EnclaveConnectionResource": { + "type": "object", + "description": "EnclaveConnection Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/EnclaveConnectionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EnclaveConnectionResourceListResult": { + "type": "object", + "description": "The response of a EnclaveConnectionResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EnclaveConnectionResource items on this page", + "items": { + "$ref": "#/definitions/EnclaveConnectionResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EnclaveConnectionSourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Mission/virtualEnclaves" + }, + { + "type": "Microsoft.Mission/communities/transitHubs" + } + ] + } + }, + "EnclaveConnectionState": { + "type": "string", + "description": "Specifies the state of the enclave connection.", + "enum": [ + "PendingApproval", + "PendingUpdate", + "Approved", + "Active", + "Failed", + "Connected", + "Disconnected" + ], + "x-ms-enum": { + "name": "EnclaveConnectionState", + "modelAsString": true, + "values": [ + { + "name": "PendingApproval", + "value": "PendingApproval", + "description": "EnclaveConnectionState Type Pending Approval" + }, + { + "name": "PendingUpdate", + "value": "PendingUpdate", + "description": "EnclaveConnectionState Type Pending Update" + }, + { + "name": "Approved", + "value": "Approved", + "description": "EnclaveConnectionState Type Approved" + }, + { + "name": "Active", + "value": "Active", + "description": "EnclaveConnectionState Type Active" + }, + { + "name": "Failed", + "value": "Failed", + "description": "EnclaveConnectionState Type Failed" + }, + { + "name": "Connected", + "value": "Connected", + "description": "EnclaveConnectionState Type Connected" + }, + { + "name": "Disconnected", + "value": "Disconnected", + "description": "EnclaveConnectionState Type Disconnected" + } + ] + } + }, + "EnclaveDefaultSettingsModel": { + "type": "object", + "description": "Virtual Enclave Default Settings", + "properties": { + "keyVaultResourceId": { + "$ref": "#/definitions/KeyVaultResourceId", + "description": "Key Vault Resource Id.", + "readOnly": true + }, + "storageAccountResourceId": { + "$ref": "#/definitions/StorageAccountResourceId", + "description": "Storage Account Resource Id.", + "readOnly": true + }, + "logAnalyticsResourceIdCollection": { + "type": "array", + "description": "Log Analytics Resource Ids.", + "items": { + "$ref": "#/definitions/LogAnalyticsResourceId" + }, + "readOnly": true + }, + "diagnosticDestination": { + "type": "string", + "description": "Diagnostic Destination.", + "default": "EnclaveOnly", + "enum": [ + "CommunityOnly", + "EnclaveOnly", + "Both" + ], + "x-ms-enum": { + "name": "DiagnosticDestination", + "modelAsString": true, + "values": [ + { + "name": "CommunityOnly", + "value": "CommunityOnly", + "description": "DiagnosticDestination Type CommunityOnly" + }, + { + "name": "EnclaveOnly", + "value": "EnclaveOnly", + "description": "DiagnosticDestination Type EnclaveOnly" + }, + { + "name": "Both", + "value": "Both", + "description": "DiagnosticDestination Type Both" + } + ] + } + } + } + }, + "EnclaveDefaultSettingsPatchModel": { + "type": "object", + "description": "Virtual Enclave Default Settings", + "properties": { + "diagnosticDestination": { + "$ref": "#/definitions/DiagnosticDestination", + "description": "Diagnostic Destination." + } + } + }, + "EnclaveEndpointDestinationRule": { + "type": "object", + "description": "Enclave Endpoint Rule Properties", + "properties": { + "protocols": { + "type": "array", + "description": "Protocols. Options specified by Endpoint Protocol Enum.", + "items": { + "$ref": "#/definitions/EnclaveEndpointProtocol" + } + }, + "name": { + "type": "string", + "description": "Endpoint Rule Name." + }, + "destination": { + "type": "string", + "description": "Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas." + }, + "port": { + "type": "string", + "description": "Port. Can include multiple ports separated by commas or a range indicated by a hyphen." + } + } + }, + "EnclaveEndpointPatchModel": { + "type": "object", + "description": "Enclave Endpoint Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/EnclaveEndpointPatchProperties", + "description": "Enclave Endpoint Patch properties" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "EnclaveEndpointPatchProperties": { + "type": "object", + "description": "Enclave Endpoint patchable Properties", + "properties": { + "ruleCollection": { + "type": "array", + "description": "Enclave Endpoint Rule Collection.", + "items": { + "$ref": "#/definitions/EnclaveEndpointDestinationRule" + }, + "x-ms-identifiers": [] + }, + "approvalRequired": { + "type": "boolean", + "description": "Whether approval is needed for the connection (True or False)." + } + } + }, + "EnclaveEndpointProperties": { + "type": "object", + "description": "Enclave Endpoint Resource properties", + "properties": { + "ruleCollection": { + "type": "array", + "description": "Enclave Endpoint Rule Collection.", + "items": { + "$ref": "#/definitions/EnclaveEndpointDestinationRule" + }, + "x-ms-identifiers": [] + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids created by community endpoint.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + }, + "approvalRequired": { + "type": "boolean", + "description": "Whether approval is needed for the connection (True or False)." + } + }, + "required": [ + "ruleCollection" + ] + }, + "EnclaveEndpointProtocol": { + "type": "string", + "description": "Enclave Endpoint Protocol Enum", + "enum": [ + "ANY", + "TCP", + "UDP", + "ICMP", + "ESP", + "AH" + ], + "x-ms-enum": { + "name": "EnclaveEndpointProtocol", + "modelAsString": true, + "values": [ + { + "name": "ANY", + "value": "ANY", + "description": "EndpointProtocol Type ANY" + }, + { + "name": "TCP", + "value": "TCP", + "description": "EndpointProtocol Type TCP" + }, + { + "name": "UDP", + "value": "UDP", + "description": "EndpointProtocol Type UDP" + }, + { + "name": "ICMP", + "value": "ICMP", + "description": "EndpointProtocol Type ICMP" + }, + { + "name": "ESP", + "value": "ESP", + "description": "EndpointProtocol Type ESP" + }, + { + "name": "AH", + "value": "AH", + "description": "EndpointProtocol Type AH" + } + ] + } + }, + "EnclaveEndpointResource": { + "type": "object", + "description": "EnclaveEndpoint Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/EnclaveEndpointProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EnclaveEndpointResourceListResult": { + "type": "object", + "description": "The response of a EnclaveEndpointResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EnclaveEndpointResource items on this page", + "items": { + "$ref": "#/definitions/EnclaveEndpointResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EnclaveResource": { + "type": "object", + "description": "Virtual Enclave Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualEnclaveProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EnclaveResourceListResult": { + "type": "object", + "description": "The response of a EnclaveResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EnclaveResource items on this page", + "items": { + "$ref": "#/definitions/EnclaveResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EnclaveVirtualNetworkModel": { + "type": "object", + "description": "Enclave Virtual Network Properties", + "properties": { + "name": { + "type": "string", + "description": "Network Name." + }, + "networkSize": { + "type": "string", + "description": "Network Size.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "customCidrRange": { + "type": "string", + "description": "Custom CIDR Range.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "subnetConfigurations": { + "type": "array", + "description": "Subnet Configurations.", + "items": { + "$ref": "#/definitions/SubnetConfiguration" + }, + "x-ms-identifiers": [] + }, + "allowSubnetCommunication": { + "type": "boolean", + "description": "Allow Subnet Communication.", + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "connectToAzureServices": { + "type": "boolean", + "description": "Connect to Azure Services (True or False).", + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "GovernedServiceItem": { + "type": "object", + "description": "GovernedServiceItem Properties", + "properties": { + "id": { + "$ref": "#/definitions/ServiceIdentifier", + "description": "Service ID" + }, + "name": { + "type": "string", + "description": "Service name.", + "readOnly": true + }, + "option": { + "type": "string", + "description": "Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable).", + "enum": [ + "Allow", + "Deny", + "ExceptionOnly", + "NotApplicable" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "enforcement": { + "type": "string", + "description": "Initiative enforcement (Enabled or Disabled).", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "auditOnly": { + "type": "boolean", + "description": "Policies set to auditOnly (True or False)." + }, + "initiatives": { + "type": "array", + "description": "Initiatives associated with this service.", + "items": { + "type": "string" + }, + "readOnly": true + } + }, + "required": [ + "id" + ] + }, + "IPGroupResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/IpGroups" + } + ] + } + }, + "KeyVaultResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + } + }, + "LogAnalyticsResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + } + }, + "MaintenanceModeConfigurationModel": { + "type": "object", + "description": "Maintenance Mode", + "properties": { + "mode": { + "type": "string", + "description": "Current mode of Maintenance Mode Configuration", + "default": "Off", + "enum": [ + "On", + "CanNotDelete", + "Off", + "General", + "Advanced" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "principals": { + "type": "array", + "description": "The user, group or service principal object affected by Maintenance Mode", + "default": [], + "items": { + "$ref": "#/definitions/Principal" + } + }, + "justification": { + "type": "string", + "description": "Justification for entering or exiting Maintenance Mode", + "default": "Off", + "enum": [ + "Networking", + "Governance", + "Off" + ], + "x-ms-enum": { + "modelAsString": true + } + } + }, + "required": [ + "mode" + ] + }, + "MaintenanceModeConfigurationPatchModel": { + "type": "object", + "description": "Maintenance Mode Patch Model", + "properties": { + "mode": { + "type": "string", + "description": "Current mode of Maintenance Mode Configuration", + "enum": [ + "On", + "CanNotDelete", + "Off", + "General", + "Advanced" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "principals": { + "type": "array", + "description": "The user, group or service principal object affected by Maintenance Mode", + "items": { + "$ref": "#/definitions/Principal" + } + }, + "justification": { + "type": "string", + "description": "Justification for entering or exiting Maintenance Mode", + "enum": [ + "Networking", + "Governance", + "Off" + ], + "x-ms-enum": { + "modelAsString": true + } + } + } + }, + "ManagedResourceGroupConfiguration": { + "type": "object", + "description": "ManagedResourceGroup related properties", + "properties": { + "name": { + "type": "string", + "description": "Name of managed resource group" + }, + "location": { + "$ref": "#/definitions/Azure.Core.azureLocation", + "description": "The geo-location where the resource lives", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "NsgResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/networkSecurityGroups" + } + ] + } + }, + "Principal": { + "type": "object", + "description": "Principal for maintenance mode or role assignments", + "properties": { + "id": { + "type": "string", + "description": "The object id associated with the principal" + }, + "type": { + "type": "string", + "description": "The type of the object id. We currently allow users, groups, and service principals", + "enum": [ + "User", + "Group", + "ServicePrincipal" + ], + "x-ms-enum": { + "modelAsString": true + } + } + }, + "required": [ + "id", + "type" + ] + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning status of the resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Creating", + "Deleting", + "NotSpecified", + "Running", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Provisioning State Type Accepted" + }, + { + "name": "Creating", + "value": "Creating", + "description": "Provisioning State Type Creating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Provisioning State Type Deleting" + }, + { + "name": "NotSpecified", + "value": "NotSpecified", + "description": "Provisioning State Type NotSpecified" + }, + { + "name": "Running", + "value": "Running", + "description": "Provisioning State Type Running" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Provisioning State Type Updating" + } + ] + }, + "readOnly": true + }, + "RequestMetadata": { + "type": "object", + "description": "Request Metadata for approvals request.", + "properties": { + "resourceAction": { + "type": "string", + "description": "Resource Action of the item being approved or declined." + }, + "approvalStatus": { + "type": "string", + "description": "Status of the approval. Uses ApprovalStatus enum.", + "default": "Pending", + "enum": [ + "Approved", + "Rejected", + "Pending" + ], + "x-ms-enum": { + "name": "ApprovalStatus", + "modelAsString": true, + "values": [ + { + "name": "Approved", + "value": "Approved", + "description": "ApprovalStatus Type Approved" + }, + { + "name": "Rejected", + "value": "Rejected", + "description": "ApprovalStatus Type Rejected" + }, + { + "name": "Pending", + "value": "Pending", + "description": "ApprovalStatus Type Pending" + } + ] + } + } + }, + "required": [ + "resourceAction" + ] + }, + "RequestMetadataUpdatableProperties": { + "type": "object", + "description": "Request Metadata patch properties.", + "properties": { + "resourceAction": { + "type": "string", + "description": "Resource Action of the item being approved or declined." + }, + "approvalStatus": { + "$ref": "#/definitions/ApprovalStatus", + "description": "Status of the approval. Uses ApprovalStatus enum." + } + } + }, + "ServiceIdentifier": { + "type": "string", + "description": "Identifier for governed services.", + "enum": [ + "AKS", + "AppService", + "AzureFirewalls", + "ContainerRegistry", + "CosmosDB", + "DataConnectors", + "Insights", + "KeyVault", + "Logic", + "MicrosoftSQL", + "Monitoring", + "PostgreSQL", + "PrivateDNSZones", + "ServiceBus", + "Storage" + ], + "x-ms-enum": { + "name": "ServiceIdentifier", + "modelAsString": true, + "values": [ + { + "name": "AKS", + "value": "AKS", + "description": "Service identifier for AKS" + }, + { + "name": "AppService", + "value": "AppService", + "description": "Service identifier for App Service" + }, + { + "name": "AzureFirewalls", + "value": "AzureFirewalls", + "description": "Service identifier for Azure Firewalls" + }, + { + "name": "ContainerRegistry", + "value": "ContainerRegistry", + "description": "Service identifier for Container Registry" + }, + { + "name": "CosmosDB", + "value": "CosmosDB", + "description": "Service identifier for CosmosDB" + }, + { + "name": "DataConnectors", + "value": "DataConnectors", + "description": "Service identifier for Data Connectors" + }, + { + "name": "Insights", + "value": "Insights", + "description": "Service identifier for Insights" + }, + { + "name": "KeyVault", + "value": "KeyVault", + "description": "Service identifier for Key Vault" + }, + { + "name": "Logic", + "value": "Logic", + "description": "Service identifier for Logic" + }, + { + "name": "MicrosoftSql", + "value": "MicrosoftSQL", + "description": "Service identifier for Microsoft SQL" + }, + { + "name": "Monitoring", + "value": "Monitoring", + "description": "Service identifier for Monitoring" + }, + { + "name": "PostgreSql", + "value": "PostgreSQL", + "description": "Service identifier for PostgreSQL" + }, + { + "name": "PrivateDNSZones", + "value": "PrivateDNSZones", + "description": "Service identifier for Private DNS Zones" + }, + { + "name": "ServiceBus", + "value": "ServiceBus", + "description": "Service identifier for Service Bus" + }, + { + "name": "Storage", + "value": "Storage", + "description": "Service identifier for Storage" + } + ] + } + }, + "StorageAccountResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + }, + "SubnetConfiguration": { + "type": "object", + "description": "Subnet Configuration", + "properties": { + "name": { + "type": "string", + "description": "Subnet name." + }, + "id": { + "$ref": "#/definitions/SubnetResourceId", + "description": "Subnet Resource ID.", + "readOnly": true + }, + "networkPrefixSize": { + "type": "integer", + "format": "int32", + "description": "Network prefix size." + }, + "subnetDelegation": { + "type": "string", + "description": "Subnet delegation." + }, + "addressPrefix": { + "type": "string", + "description": "Address prefix.", + "readOnly": true + }, + "networkSecurityGroupId": { + "$ref": "#/definitions/NsgResourceId", + "description": "Network security group ID.", + "readOnly": true + } + }, + "required": [ + "name", + "networkPrefixSize" + ] + }, + "SubnetResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "TransitHubPatchModel": { + "type": "object", + "description": "TH Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/TransitHubPatchProperties", + "description": "The TransitHub resource." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TransitHubPatchProperties": { + "type": "object", + "description": "Transit Hub patchable Properties", + "properties": { + "state": { + "$ref": "#/definitions/TransitHubState", + "description": "The state of the transitHub." + }, + "transitOption": { + "$ref": "#/definitions/TransitOption", + "description": "The TransitOption of the transitHub." + } + } + }, + "TransitHubProperties": { + "type": "object", + "description": "Describes the properties of an Transit Hub.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/TransitHubState", + "description": "The state of the transitHub." + }, + "transitOption": { + "$ref": "#/definitions/TransitOption", + "description": "The TransitOption of the transitHub." + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids modified by transitHubs.", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "TransitHubResource": { + "type": "object", + "description": "TransitHub Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/TransitHubProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "TransitHubResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Mission/communities/transitHubs" + } + ] + } + }, + "TransitHubResourceListResult": { + "type": "object", + "description": "The response of a TransitHubResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The TransitHubResource items on this page", + "items": { + "$ref": "#/definitions/TransitHubResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "TransitHubState": { + "type": "string", + "description": "Specifies the state of the transitHub.", + "enum": [ + "PendingApproval", + "Approved", + "PendingUpdate", + "Active", + "Failed" + ], + "x-ms-enum": { + "name": "TransitHubState", + "modelAsString": true, + "values": [ + { + "name": "PendingApproval", + "value": "PendingApproval", + "description": "TransitHubState Type PendingApproval" + }, + { + "name": "Approved", + "value": "Approved", + "description": "TransitHubState Type Approved" + }, + { + "name": "PendingUpdate", + "value": "PendingUpdate", + "description": "TransitHubState Type PendingUpdate" + }, + { + "name": "Active", + "value": "Active", + "description": "TransitHubState Type Active" + }, + { + "name": "Failed", + "value": "Failed", + "description": "TransitHubState Type Failed" + } + ] + } + }, + "TransitOption": { + "type": "object", + "description": "TransitOption Properties", + "properties": { + "type": { + "$ref": "#/definitions/TransitOptionType", + "description": "Transit Option Type." + }, + "params": { + "$ref": "#/definitions/TransitOptionParams", + "description": "Transit Option Params" + } + } + }, + "TransitOptionParams": { + "type": "object", + "description": "TransitOptionParams Properties", + "properties": { + "scaleUnits": { + "type": "integer", + "format": "int64", + "description": "Transit Option Params scaleUnits." + }, + "remoteVirtualNetworkId": { + "$ref": "#/definitions/VirtualNetworkResourceId", + "description": "Transit Option Params remoteVirtualNetworkId." + } + } + }, + "TransitOptionType": { + "type": "string", + "description": "Specifies the type of the transitOption.", + "enum": [ + "ExpressRoute", + "Gateway", + "Peering" + ], + "x-ms-enum": { + "name": "TransitOptionType", + "modelAsString": true, + "values": [ + { + "name": "ExpressRoute", + "value": "ExpressRoute", + "description": "TransitOptionType ExpressRoute" + }, + { + "name": "Gateway", + "value": "Gateway", + "description": "TransitOptionType Gateway" + }, + { + "name": "Peering", + "value": "Peering", + "description": "TransitOptionType Peering" + } + ] + } + }, + "VirtualEnclavePatchModel": { + "type": "object", + "description": "Virtual Enclave Patch Model", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualEnclavePatchProperties", + "description": "Virtual Enclave Patch properties" + }, + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.ManagedServiceIdentityUpdate", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualEnclavePatchProperties": { + "type": "object", + "description": "Virtual Enclave Patchable Properties", + "properties": { + "enclaveVirtualNetwork": { + "$ref": "#/definitions/EnclaveVirtualNetworkModel", + "description": "Virtual Network." + }, + "bastionEnabled": { + "type": "boolean", + "description": "Deploy Bastion service (True or False)." + }, + "enclaveDefaultSettings": { + "$ref": "#/definitions/EnclaveDefaultSettingsPatchModel", + "description": "Enclave default settings." + }, + "maintenanceModeConfiguration": { + "$ref": "#/definitions/MaintenanceModeConfigurationPatchModel", + "description": "Maintenance Mode configuration." + } + } + }, + "VirtualEnclaveProperties": { + "type": "object", + "description": "Virtual Enclave Resource properties", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + }, + "enclaveVirtualNetwork": { + "$ref": "#/definitions/EnclaveVirtualNetworkModel", + "description": "Virtual Network." + }, + "enclaveAddressSpaces": { + "$ref": "#/definitions/EnclaveAddressSpacesModel", + "description": "Enclave Address Spaces", + "readOnly": true + }, + "communityResourceId": { + "$ref": "#/definitions/CommunityResourceId", + "description": "Community Resource Id.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids created by Virtual Enclave.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource." + }, + "readOnly": true + }, + "managedResourceGroupConfiguration": { + "$ref": "#/definitions/ManagedResourceGroupConfiguration", + "description": "Managed resource group name.", + "readOnly": true + }, + "bastionEnabled": { + "type": "boolean", + "description": "Deploy Bastion service (True or False).", + "default": false + }, + "enclaveDefaultSettings": { + "$ref": "#/definitions/EnclaveDefaultSettingsModel", + "description": "Enclave default settings." + }, + "maintenanceModeConfiguration": { + "$ref": "#/definitions/MaintenanceModeConfigurationModel", + "description": "Maintenance Mode configuration." + } + }, + "required": [ + "enclaveVirtualNetwork", + "communityResourceId" + ] + }, + "VirtualNetworkResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks" + } + ] + } + }, + "WorkloadPatchModel": { + "type": "object", + "description": "Workload Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadPatchProperties", + "description": "Workload Patch properties" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "WorkloadPatchProperties": { + "type": "object", + "description": "Workload patchable Properties", + "properties": { + "resourceGroupCollection": { + "type": "array", + "description": "List of resource group ids.", + "items": { + "type": "string" + } + } + } + }, + "WorkloadProperties": { + "type": "object", + "description": "Workload Resource properties", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + }, + "resourceGroupCollection": { + "type": "array", + "description": "List of resource group ids.", + "items": { + "type": "string" + } + } + } + }, + "WorkloadResource": { + "type": "object", + "description": "Workload Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "WorkloadResourceListResult": { + "type": "object", + "description": "The response of a WorkloadResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadResource items on this page", + "items": { + "$ref": "#/definitions/WorkloadResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + } + }, + "parameters": { + "Azure.ResourceManager.ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "description": "The fully qualified Azure Resource manager identifier of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_CreateOrUpdate.json new file mode 100644 index 000000000000..62f7acb39c6c --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_CreateOrUpdate.json @@ -0,0 +1,108 @@ +{ + "title": "Approval_CreateOrUpdate", + "operationId": "Approval_CreateOrUpdate", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-12-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "resource": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_Delete.json new file mode 100644 index 000000000000..8d0b4841aab2 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "Approval_Delete", + "operationId": "Approval_Delete", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_Get.json new file mode 100644 index 000000000000..3113f3601e33 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_Get.json @@ -0,0 +1,49 @@ +{ + "title": "Approval_Get", + "operationId": "Approval_Get", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_InitiatorCallback.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_InitiatorCallback.json new file mode 100644 index 000000000000..0ecaf5494bda --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_InitiatorCallback.json @@ -0,0 +1,28 @@ +{ + "title": "Approval_InitiatorCallback", + "operationId": "Approval_InitiatorCallback", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "body": { + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approved" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_ListByParent.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_ListByParent.json new file mode 100644 index 000000000000..8d559f5776d8 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_ListByParent.json @@ -0,0 +1,54 @@ +{ + "title": "Approval_ListByParent", + "operationId": "Approval_ListByParent", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_Update.json new file mode 100644 index 000000000000..c9c7bded4b5c --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Approvals_Update.json @@ -0,0 +1,75 @@ +{ + "title": "Approval_Update", + "operationId": "Approval_Update", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2024-12-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "properties": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "parent1": "string", + "parent2": "string", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_ApprovalDeletionCallback.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_ApprovalDeletionCallback.json new file mode 100644 index 000000000000..fa398f9853ef --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_ApprovalDeletionCallback.json @@ -0,0 +1,28 @@ +{ + "operationId": "CommunityEndpoints_ApprovalDeletionCallback", + "title": "CommunityEndpoints_ApprovalDeletionCallback", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_CreateOrUpdate.json new file mode 100644 index 000000000000..20a98ce1c8f1 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_CreateOrUpdate.json @@ -0,0 +1,101 @@ +{ + "title": "CommunityEndpoints_CreateOrUpdate", + "operationId": "CommunityEndpoints_CreateOrUpdate", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "resource": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communties/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_Delete.json new file mode 100644 index 000000000000..264bcf0175dc --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "CommunityEndpoints_Delete", + "operationId": "CommunityEndpoints_Delete", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_Get.json new file mode 100644 index 000000000000..bcc51c769d67 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_Get.json @@ -0,0 +1,46 @@ +{ + "title": "CommunityEndpoints_Get", + "operationId": "CommunityEndpoints_Get", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_ListByCommunityResource.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_ListByCommunityResource.json new file mode 100644 index 000000000000..b827d5a8e169 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_ListByCommunityResource.json @@ -0,0 +1,51 @@ +{ + "title": "CommunityEndpoints_ListByCommunityResource", + "operationId": "CommunityEndpoints_ListByCommunityResource", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_ListBySubscription.json new file mode 100644 index 000000000000..73ec29456211 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_ListBySubscription.json @@ -0,0 +1,50 @@ +{ + "title": "CommunityEndpoints_ListBySubscription", + "operationId": "CommunityEndpoints_ListBySubscription", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_PostApprovalCallback.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_PostApprovalCallback.json new file mode 100644 index 000000000000..c7c35fba91b5 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_PostApprovalCallback.json @@ -0,0 +1,29 @@ +{ + "operationId": "CommunityEndpoints_ApprovalCallback", + "title": "CommunityEndpoints_ApprovalCallback", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_Update.json new file mode 100644 index 000000000000..b035aaceec9a --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/CommunityEndpoints_Update.json @@ -0,0 +1,70 @@ +{ + "title": "CommunityEndpoints_Update", + "operationId": "CommunityEndpoints_Update", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "port": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_CreateOrUpdate.json new file mode 100644 index 000000000000..f7c4d6f7aeb5 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_CreateOrUpdate.json @@ -0,0 +1,612 @@ +{ + "title": "Community_CreateOrUpdate", + "operationId": "Community_CreateOrUpdate", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "resource": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "governedServiceList": [ + { + "id": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "AppService", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "ContainerRegistry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "KeyVault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "MicrosoftSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "ServiceBus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "AzureFirewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "PrivateDNSZones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "DataConnectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + } + ], + "communityRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "approvalSettings": { + "endpointCreation": "NotRequired", + "endpointUpdate": "Required", + "endpointDeletion": "NotRequired", + "connectionCreation": "Required", + "connectionUpdate": "Required", + "connectionDeletion": "NotRequired", + "enclaveCreation": "NotRequired", + "enclaveDeletion": "NotRequired", + "maintenanceMode": "NotRequired", + "serviceCatalogDeployment": "NotRequired", + "notificationOnApprovalCreation": "NotRequired", + "notificationOnApprovalAction": "NotRequired", + "notificationOnApprovalDeletion": "NotRequired", + "mandatoryApprovers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000" + } + ], + "minimumApproversRequired": 0 + }, + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + } + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + } + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + } + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_Delete.json new file mode 100644 index 000000000000..c01710543bc8 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "Community_Delete", + "operationId": "Community_Delete", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_Get.json new file mode 100644 index 000000000000..89216c841dc6 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_Get.json @@ -0,0 +1,228 @@ +{ + "title": "Community_Get", + "operationId": "Community_Get", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + } + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_ListByResourceGroup.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_ListByResourceGroup.json new file mode 100644 index 000000000000..6bff3f7f7ee5 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_ListByResourceGroup.json @@ -0,0 +1,232 @@ +{ + "title": "Community_ListByResourceGroup", + "operationId": "Community_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + } + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_ListBySubscription.json new file mode 100644 index 000000000000..3cbb49e39f8a --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_ListBySubscription.json @@ -0,0 +1,231 @@ +{ + "title": "Community_ListBySubscription", + "operationId": "Community_ListBySubscription", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + } + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_PostCheckAddressSpaceAvailability.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_PostCheckAddressSpaceAvailability.json new file mode 100644 index 000000000000..1855637bff96 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_PostCheckAddressSpaceAvailability.json @@ -0,0 +1,33 @@ +{ + "operationId": "Community_CheckAddressSpaceAvailability", + "title": "Community_CheckAddressSpaceAvailability", + "parameters": { + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "checkAddressSpaceAvailabilityRequest": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + } + }, + "api-version": "2024-12-01-preview" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": true + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_Update.json new file mode 100644 index 000000000000..5a07ba852fe2 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Community_Update.json @@ -0,0 +1,358 @@ +{ + "title": "Community_Update", + "operationId": "Community_Update", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "dnsServers": [ + "azure.net" + ], + "governedServiceList": [ + { + "id": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "AppService", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "ContainerRegistry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "KeyVault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "MicrosoftSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "ServiceBus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "AzureFirewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "PrivateDNSZones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + }, + { + "id": "DataConnectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false + } + ], + "communityRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "resCollection" + ], + "governedServiceList": [ + { + "id": "AKS", + "name": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "id": "AppService", + "name": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "id": "ContainerRegistry", + "name": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "id": "CosmosDB", + "name": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "id": "KeyVault", + "name": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "id": "MicrosoftSQL", + "name": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "id": "Monitoring", + "name": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "id": "PostgreSQL", + "name": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "id": "ServiceBus", + "name": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "id": "Storage", + "name": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "id": "AzureFirewalls", + "name": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Insights", + "name": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "Logic", + "name": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "PrivateDNSZones", + "name": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + }, + { + "id": "DataConnectors", + "name": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "auditOnly": false, + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_ApprovalDeletionCallback.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_ApprovalDeletionCallback.json new file mode 100644 index 000000000000..c858a8845ec0 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_ApprovalDeletionCallback.json @@ -0,0 +1,27 @@ +{ + "operationId": "EnclaveConnection_ApprovalDeletionCallback", + "title": "EnclaveConnection_ApprovalDeletionCallback", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_CreateOrUpdate.json new file mode 100644 index 000000000000..87c36c9aac13 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_CreateOrUpdate.json @@ -0,0 +1,79 @@ +{ + "title": "EnclaveConnection_CreateOrUpdate", + "operationId": "EnclaveConnection_CreateOrUpdate", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "resource": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_Delete.json new file mode 100644 index 000000000000..bab672f52509 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "EnclaveConnection_Delete", + "operationId": "EnclaveConnection_Delete", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_Get.json new file mode 100644 index 000000000000..203c445fb889 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_Get.json @@ -0,0 +1,38 @@ +{ + "title": "EnclaveConnection_Get", + "operationId": "EnclaveConnection_Get", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_ListByResourceGroup.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_ListByResourceGroup.json new file mode 100644 index 000000000000..8604ecfca65d --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_ListByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "title": "EnclaveConnection_ListByResourceGroup", + "operationId": "EnclaveConnection_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_ListBySubscription.json new file mode 100644 index 000000000000..170e87db1f8e --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_ListBySubscription.json @@ -0,0 +1,42 @@ +{ + "title": "EnclaveConnection_ListBySubscription", + "operationId": "EnclaveConnection_ListBySubscription", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_PostApprovalCallback.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_PostApprovalCallback.json new file mode 100644 index 000000000000..2b60a2383061 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_PostApprovalCallback.json @@ -0,0 +1,29 @@ +{ + "operationId": "EnclaveConnection_ApprovalCallback", + "title": "EnclaveConnection_ApprovalCallback", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_Update.json new file mode 100644 index 000000000000..a58da002e704 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveConnection_Update.json @@ -0,0 +1,52 @@ +{ + "title": "EnclaveConnection_Update", + "operationId": "EnclaveConnection_Update", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "sourceCidr": "10.0.0.0/24" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_ApprovalDeletionCallback.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_ApprovalDeletionCallback.json new file mode 100644 index 000000000000..dd2a57fb4804 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_ApprovalDeletionCallback.json @@ -0,0 +1,28 @@ +{ + "operationId": "EnclaveEndpoints_ApprovalDeletionCallback", + "title": "EnclaveEndpoints_ApprovalDeletionCallback", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_CreateOrUpdate.json new file mode 100644 index 000000000000..344891e840f3 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_CreateOrUpdate.json @@ -0,0 +1,98 @@ +{ + "title": "EnclaveEndpoints_CreateOrUpdate", + "operationId": "EnclaveEndpoints_CreateOrUpdate", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "resource": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_Delete.json new file mode 100644 index 000000000000..3ed62f38ab8b --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "EnclaveEndpoints_Delete", + "operationId": "EnclaveEndpoints_Delete", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_Get.json new file mode 100644 index 000000000000..7b2124dcc5f8 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_Get.json @@ -0,0 +1,45 @@ +{ + "title": "EnclaveEndpoints_Get", + "operationId": "EnclaveEndpoints_Get", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint" + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_ListByEnclaveResource.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_ListByEnclaveResource.json new file mode 100644 index 000000000000..f08df0b1416f --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_ListByEnclaveResource.json @@ -0,0 +1,49 @@ +{ + "title": "EnclaveEndpoints_ListByEnclaveResource", + "operationId": "EnclaveEndpoints_ListByEnclaveResource", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_ListBySubscription.json new file mode 100644 index 000000000000..cfbcc8ae3450 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "title": "EnclaveEndpoints_ListBySubscription", + "operationId": "EnclaveEndpoints_ListBySubscription", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_PostApprovalCallback.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_PostApprovalCallback.json new file mode 100644 index 000000000000..c348942e7450 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_PostApprovalCallback.json @@ -0,0 +1,29 @@ +{ + "operationId": "EnclaveEndpoints_ApprovalCallback", + "title": "EnclaveEndpoints_ApprovalCallback", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_Update.json new file mode 100644 index 000000000000..40700272a17a --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/EnclaveEndpoints_Update.json @@ -0,0 +1,68 @@ +{ + "title": "EnclaveEndpoints_Update", + "operationId": "EnclaveEndpoints_Update", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "name": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "port": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Operations_List.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..d494dc5ec820 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Operations_List.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "kribdpoznbvrjci", + "isDataAction": true, + "display": { + "provider": "usvnnruysydqdpwj", + "resource": "lrdjzltcbeoljosqrw", + "operation": "vdnitexr", + "description": "valid description goes here" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_CreateOrUpdate.json new file mode 100644 index 000000000000..51421c5cfb8e --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_CreateOrUpdate.json @@ -0,0 +1,95 @@ +{ + "title": "TransitHub_CreateOrUpdate", + "operationId": "TransitHub_CreateOrUpdate", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName", + "resource": { + "properties": { + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + } + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "zwwdhidevngwzo", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_Delete.json new file mode 100644 index 000000000000..d75b92834b1a --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "TransitHub_Delete", + "operationId": "TransitHub_Delete", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_Get.json new file mode 100644 index 000000000000..84166b8378e9 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_Get.json @@ -0,0 +1,45 @@ +{ + "title": "TransitHub_Get", + "operationId": "TransitHub_Get", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_ListByCommunityResource.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_ListByCommunityResource.json new file mode 100644 index 000000000000..171f9b188efc --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_ListByCommunityResource.json @@ -0,0 +1,49 @@ +{ + "title": "TransitHub_ListByCommunityResource", + "operationId": "TransitHub_ListByCommunityResource", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithub", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_ListBySubscription.json new file mode 100644 index 000000000000..88b931594a3b --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "title": "TransitHub_ListBySubscription", + "operationId": "TransitHub_ListBySubscription", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_Update.json new file mode 100644 index 000000000000..7f7bdf093736 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/TransitHub_Update.json @@ -0,0 +1,65 @@ +{ + "title": "TransitHub_Update", + "operationId": "TransitHub_Update", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName", + "location": "westcentralus", + "properties": { + "tags": { + "key4278": "hjoxhwofxcshowbnafdrrzq" + }, + "properties": { + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "resCollection" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_CreateOrUpdate.json new file mode 100644 index 000000000000..0d35fabd2395 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_CreateOrUpdate.json @@ -0,0 +1,322 @@ +{ + "title": "VirtualEnclave_CreateOrUpdate", + "operationId": "VirtualEnclave_CreateOrUpdate", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "resource": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "diagnosticDestination": "Both" + }, + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "id": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "id": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "id": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "id": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "id": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "id": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_Delete.json new file mode 100644 index 000000000000..b5ab6ed0658c --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "VirtualEnclave_Delete", + "operationId": "VirtualEnclave_Delete", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_Get.json new file mode 100644 index 000000000000..99f271b3ed7f --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_Get.json @@ -0,0 +1,129 @@ +{ + "title": "VirtualEnclave_Get", + "operationId": "VirtualEnclave_Get", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "id": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "id": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_ListByResourceGroup.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_ListByResourceGroup.json new file mode 100644 index 000000000000..14f20d08e578 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_ListByResourceGroup.json @@ -0,0 +1,133 @@ +{ + "title": "VirtualEnclave_ListByResourceGroup", + "operationId": "VirtualEnclave_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "id": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "id": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_ListBySubscription.json new file mode 100644 index 000000000000..7fb8d522a3d0 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_ListBySubscription.json @@ -0,0 +1,132 @@ +{ + "title": "VirtualEnclave_ListBySubscription", + "operationId": "VirtualEnclave_ListBySubscription", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "id": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "id": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_PostApprovalCallback.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_PostApprovalCallback.json new file mode 100644 index 000000000000..2237f8ffc0bc --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_PostApprovalCallback.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualEnclave_ApprovalCallback", + "title": "VirtualEnclave_ApprovalCallback", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_PostApprovalDeletionCallback.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_PostApprovalDeletionCallback.json new file mode 100644 index 000000000000..cfa29b89657f --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_PostApprovalDeletionCallback.json @@ -0,0 +1,27 @@ +{ + "operationId": "VirtualEnclave_ApprovalDeletionCallback", + "title": "VirtualEnclave_ApprovalDeletionCallback", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_Update.json new file mode 100644 index 000000000000..77752d7175ad --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/VirtualEnclave_Update.json @@ -0,0 +1,216 @@ +{ + "title": "VirtualEnclave_Update", + "operationId": "VirtualEnclave_Update", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "westcentralus", + "properties": { + "tags": { + "Tag1": "Value1" + }, + "properties": { + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "enclaveDefaultSettings": { + "diagnosticDestination": "Both" + }, + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "id": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "id": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "name": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true, + "connectToAzureServices": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "id": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "id": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "id": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "id": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_CreateOrUpdate.json new file mode 100644 index 000000000000..958d114c8332 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_CreateOrUpdate.json @@ -0,0 +1,71 @@ +{ + "title": "Workload_CreateOrUpdate", + "operationId": "Workload_CreateOrUpdate", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload", + "resource": { + "properties": { + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_Delete.json new file mode 100644 index 000000000000..635ca18032d6 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "Workload_Delete", + "operationId": "Workload_Delete", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_Get.json new file mode 100644 index 000000000000..fad104de4185 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_Get.json @@ -0,0 +1,38 @@ +{ + "title": "Workload_Get", + "operationId": "Workload_Get", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_ListByEnclaveResource.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_ListByEnclaveResource.json new file mode 100644 index 000000000000..56759b0e4fa2 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_ListByEnclaveResource.json @@ -0,0 +1,42 @@ +{ + "title": "Workload_ListByEnclaveResource", + "operationId": "Workload_ListByEnclaveResource", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_ListBySubscription.json new file mode 100644 index 000000000000..2329cd7c0d4c --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "title": "Workload_ListBySubscription", + "operationId": "Workload_ListBySubscription", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_Update.json new file mode 100644 index 000000000000..f78c95500f5e --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/examples/Workload_Update.json @@ -0,0 +1,54 @@ +{ + "title": "Workload_Update", + "operationId": "Workload_Update", + "parameters": { + "api-version": "2024-12-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload", + "location": "westcentralus", + "properties": { + "tags": { + "key9465": "cylmdprdhhwpcdxpynwostvzytkryj" + }, + "properties": { + "resourceGroupCollection": [ + "g" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/openapi.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/openapi.json new file mode 100644 index 000000000000..c108d0f95f3d --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2024-12-01-preview/openapi.json @@ -0,0 +1,6239 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Mission", + "version": "2024-12-01-preview", + "description": "Microsoft Mission Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Workload" + }, + { + "name": "VirtualEnclave" + }, + { + "name": "Community" + }, + { + "name": "TransitHub" + }, + { + "name": "EnclaveConnection" + }, + { + "name": "EnclaveEndpoints" + }, + { + "name": "CommunityEndpoints" + }, + { + "name": "Approval" + } + ], + "paths": { + "/{resourceUri}/providers/Microsoft.Mission/approvals": { + "get": { + "operationId": "Approval_ListByParent", + "tags": [ + "Approval" + ], + "description": "List ApprovalResource resources by parent", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_ListByParent": { + "$ref": "./examples/Approvals_ListByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.Mission/approvals/{approvalName}": { + "get": { + "operationId": "Approval_Get", + "tags": [ + "Approval" + ], + "description": "Get a ApprovalResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "approvalName", + "in": "path", + "description": "The name of the approvals resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_Get": { + "$ref": "./examples/Approvals_Get.json" + } + } + }, + "put": { + "operationId": "Approval_CreateOrUpdate", + "tags": [ + "Approval" + ], + "description": "Create a ApprovalResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "approvalName", + "in": "path", + "description": "The name of the approvals resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ApprovalResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/ApprovalResource" + } + }, + "201": { + "description": "Resource 'ApprovalResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/ApprovalResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_CreateOrUpdate": { + "$ref": "./examples/Approvals_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Approval_Update", + "tags": [ + "Approval" + ], + "description": "Update a ApprovalResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "approvalName", + "in": "path", + "description": "The name of the approvals resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_Update": { + "$ref": "./examples/Approvals_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Approval_Delete", + "tags": [ + "Approval" + ], + "description": "Delete a ApprovalResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "approvalName", + "in": "path", + "description": "The name of the approvals resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_Delete": { + "$ref": "./examples/Approvals_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.Mission/approvals/{approvalName}/initiatorCallback": { + "post": { + "operationId": "Approval_InitiatorCallback", + "tags": [ + "Approval" + ], + "description": "Upon receiving approval or rejection from approver, this facilitates actions on approval resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "approvalName", + "in": "path", + "description": "The name of the approvals resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalActionRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_InitiatorCallback": { + "$ref": "./examples/Approvals_InitiatorCallback.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.Mission/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/communities": { + "get": { + "operationId": "Community_ListBySubscription", + "tags": [ + "Community" + ], + "description": "List CommunityResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_ListBySubscription": { + "$ref": "./examples/Community_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints": { + "get": { + "operationId": "CommunityEndpoints_ListBySubscription", + "tags": [ + "CommunityEndpoints" + ], + "description": "List CommunityEndpointResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityEndpointResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_ListBySubscription": { + "$ref": "./examples/CommunityEndpoints_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/communities/{communityName}/transitHubs": { + "get": { + "operationId": "TransitHub_ListBySubscription", + "tags": [ + "TransitHub" + ], + "description": "List TransitHubResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TransitHubResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_ListBySubscription": { + "$ref": "./examples/TransitHub_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/enclaveConnections": { + "get": { + "operationId": "EnclaveConnection_ListBySubscription", + "tags": [ + "EnclaveConnection" + ], + "description": "List EnclaveConnectionResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_ListBySubscription": { + "$ref": "./examples/EnclaveConnection_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/virtualEnclaves": { + "get": { + "operationId": "VirtualEnclave_ListBySubscription", + "tags": [ + "VirtualEnclave" + ], + "description": "List EnclaveResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_ListBySubscription": { + "$ref": "./examples/VirtualEnclave_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints": { + "get": { + "operationId": "EnclaveEndpoints_ListBySubscription", + "tags": [ + "EnclaveEndpoints" + ], + "description": "List EnclaveEndpointResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_ListBySubscription": { + "$ref": "./examples/EnclaveEndpoints_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/workloads": { + "get": { + "operationId": "Workload_ListBySubscription", + "tags": [ + "Workload" + ], + "description": "List WorkloadResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_ListBySubscription": { + "$ref": "./examples/Workload_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities": { + "get": { + "operationId": "Community_ListByResourceGroup", + "tags": [ + "Community" + ], + "description": "List CommunityResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_ListByResourceGroup": { + "$ref": "./examples/Community_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}": { + "get": { + "operationId": "Community_Get", + "tags": [ + "Community" + ], + "description": "Get a CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_Get": { + "$ref": "./examples/Community_Get.json" + } + } + }, + "put": { + "operationId": "Community_CreateOrUpdate", + "tags": [ + "Community" + ], + "description": "Create a CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunityResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CommunityResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/CommunityResource" + } + }, + "201": { + "description": "Resource 'CommunityResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/CommunityResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_CreateOrUpdate": { + "$ref": "./examples/Community_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Community_Update", + "tags": [ + "Community" + ], + "description": "Update a CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunityPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_Update": { + "$ref": "./examples/Community_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Community_Delete", + "tags": [ + "Community" + ], + "description": "Delete a CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_Delete": { + "$ref": "./examples/Community_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/checkAddressSpaceAvailability": { + "post": { + "operationId": "Community_CheckAddressSpaceAvailability", + "tags": [ + "Community" + ], + "description": "Checks that the IP Address Space to be allocated for this Community is available.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "checkAddressSpaceAvailabilityRequest", + "in": "body", + "description": "Check IP Address Space request body.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckAddressSpaceAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CheckAddressSpaceAvailabilityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_CheckAddressSpaceAvailability": { + "$ref": "./examples/Community_PostCheckAddressSpaceAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints": { + "get": { + "operationId": "CommunityEndpoints_ListByCommunityResource", + "tags": [ + "CommunityEndpoints" + ], + "description": "List CommunityEndpointResource resources by CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityEndpointResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_ListByCommunityResource": { + "$ref": "./examples/CommunityEndpoints_ListByCommunityResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints/{communityEndpointName}": { + "get": { + "operationId": "CommunityEndpoints_Get", + "tags": [ + "CommunityEndpoints" + ], + "description": "Get a CommunityEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "communityEndpointName", + "in": "path", + "description": "The name of the Community Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityEndpointResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_Get": { + "$ref": "./examples/CommunityEndpoints_Get.json" + } + } + }, + "put": { + "operationId": "CommunityEndpoints_CreateOrUpdate", + "tags": [ + "CommunityEndpoints" + ], + "description": "Create a CommunityEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "communityEndpointName", + "in": "path", + "description": "The name of the Community Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunityEndpointResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CommunityEndpointResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/CommunityEndpointResource" + } + }, + "201": { + "description": "Resource 'CommunityEndpointResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/CommunityEndpointResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_CreateOrUpdate": { + "$ref": "./examples/CommunityEndpoints_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CommunityEndpoints_Update", + "tags": [ + "CommunityEndpoints" + ], + "description": "Update a CommunityEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "communityEndpointName", + "in": "path", + "description": "The name of the Community Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunityEndpointPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityEndpointResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_Update": { + "$ref": "./examples/CommunityEndpoints_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CommunityEndpoints_Delete", + "tags": [ + "CommunityEndpoints" + ], + "description": "Delete a CommunityEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "communityEndpointName", + "in": "path", + "description": "The name of the Community Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_Delete": { + "$ref": "./examples/CommunityEndpoints_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints/{communityEndpointName}/approvalCallback": { + "post": { + "operationId": "CommunityEndpoints_ApprovalCallback", + "tags": [ + "CommunityEndpoints" + ], + "description": "Callback that triggers on approval state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "communityEndpointName", + "in": "path", + "description": "The name of the Community Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_ApprovalCallback": { + "$ref": "./examples/CommunityEndpoints_PostApprovalCallback.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints/{communityEndpointName}/approvalDeletionCallback": { + "post": { + "operationId": "CommunityEndpoints_ApprovalDeletionCallback", + "tags": [ + "CommunityEndpoints" + ], + "description": "Callback that triggers on approval deletion state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "communityEndpointName", + "in": "path", + "description": "The name of the Community Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalDeletionCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_ApprovalDeletionCallback": { + "$ref": "./examples/CommunityEndpoints_ApprovalDeletionCallback.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/transitHubs": { + "get": { + "operationId": "TransitHub_ListByCommunityResource", + "tags": [ + "TransitHub" + ], + "description": "List TransitHubResource resources by CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TransitHubResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_ListByCommunityResource": { + "$ref": "./examples/TransitHub_ListByCommunityResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/transitHubs/{transitHubName}": { + "get": { + "operationId": "TransitHub_Get", + "tags": [ + "TransitHub" + ], + "description": "Get a TransitHubResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "transitHubName", + "in": "path", + "description": "The name of the TransitHub Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TransitHubResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_Get": { + "$ref": "./examples/TransitHub_Get.json" + } + } + }, + "put": { + "operationId": "TransitHub_CreateOrUpdate", + "tags": [ + "TransitHub" + ], + "description": "Create a TransitHubResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "transitHubName", + "in": "path", + "description": "The name of the TransitHub Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TransitHubResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'TransitHubResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/TransitHubResource" + } + }, + "201": { + "description": "Resource 'TransitHubResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/TransitHubResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_CreateOrUpdate": { + "$ref": "./examples/TransitHub_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "TransitHub_Update", + "tags": [ + "TransitHub" + ], + "description": "Update a TransitHubResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "transitHubName", + "in": "path", + "description": "The name of the TransitHub Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/TransitHubPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TransitHubResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_Update": { + "$ref": "./examples/TransitHub_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "TransitHub_Delete", + "tags": [ + "TransitHub" + ], + "description": "Delete a TransitHubResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "transitHubName", + "in": "path", + "description": "The name of the TransitHub Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_Delete": { + "$ref": "./examples/TransitHub_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections": { + "get": { + "operationId": "EnclaveConnection_ListByResourceGroup", + "tags": [ + "EnclaveConnection" + ], + "description": "List EnclaveConnectionResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_ListByResourceGroup": { + "$ref": "./examples/EnclaveConnection_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections/{enclaveConnectionName}": { + "get": { + "operationId": "EnclaveConnection_Get", + "tags": [ + "EnclaveConnection" + ], + "description": "Get a EnclaveConnectionResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_Get": { + "$ref": "./examples/EnclaveConnection_Get.json" + } + } + }, + "put": { + "operationId": "EnclaveConnection_CreateOrUpdate", + "tags": [ + "EnclaveConnection" + ], + "description": "Create a EnclaveConnectionResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EnclaveConnectionResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EnclaveConnectionResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResource" + } + }, + "201": { + "description": "Resource 'EnclaveConnectionResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_CreateOrUpdate": { + "$ref": "./examples/EnclaveConnection_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EnclaveConnection_Update", + "tags": [ + "EnclaveConnection" + ], + "description": "Update a EnclaveConnectionResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EnclaveConnectionPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_Update": { + "$ref": "./examples/EnclaveConnection_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EnclaveConnection_Delete", + "tags": [ + "EnclaveConnection" + ], + "description": "Delete a EnclaveConnectionResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_Delete": { + "$ref": "./examples/EnclaveConnection_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections/{enclaveConnectionName}/approvalCallback": { + "post": { + "operationId": "EnclaveConnection_ApprovalCallback", + "tags": [ + "EnclaveConnection" + ], + "description": "Callback that triggers on approval state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_ApprovalCallback": { + "$ref": "./examples/EnclaveConnection_PostApprovalCallback.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections/{enclaveConnectionName}/approvalDeletionCallback": { + "post": { + "operationId": "EnclaveConnection_ApprovalDeletionCallback", + "tags": [ + "EnclaveConnection" + ], + "description": "Callback that triggers on approval deletion state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalDeletionCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_ApprovalDeletionCallback": { + "$ref": "./examples/EnclaveConnection_ApprovalDeletionCallback.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves": { + "get": { + "operationId": "VirtualEnclave_ListByResourceGroup", + "tags": [ + "VirtualEnclave" + ], + "description": "List EnclaveResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_ListByResourceGroup": { + "$ref": "./examples/VirtualEnclave_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}": { + "get": { + "operationId": "VirtualEnclave_Get", + "tags": [ + "VirtualEnclave" + ], + "description": "Get a EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_Get": { + "$ref": "./examples/VirtualEnclave_Get.json" + } + } + }, + "put": { + "operationId": "VirtualEnclave_CreateOrUpdate", + "tags": [ + "VirtualEnclave" + ], + "description": "Create a EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EnclaveResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EnclaveResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveResource" + } + }, + "201": { + "description": "Resource 'EnclaveResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_CreateOrUpdate": { + "$ref": "./examples/VirtualEnclave_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VirtualEnclave_Update", + "tags": [ + "VirtualEnclave" + ], + "description": "Update a EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualEnclavePatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_Update": { + "$ref": "./examples/VirtualEnclave_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualEnclave_Delete", + "tags": [ + "VirtualEnclave" + ], + "description": "Delete a EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_Delete": { + "$ref": "./examples/VirtualEnclave_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/approvalCallback": { + "post": { + "operationId": "VirtualEnclave_ApprovalCallback", + "tags": [ + "VirtualEnclave" + ], + "description": "Callback that triggers on approval state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_ApprovalCallback": { + "$ref": "./examples/VirtualEnclave_PostApprovalCallback.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/approvalDeletionCallback": { + "post": { + "operationId": "VirtualEnclave_ApprovalDeletionCallback", + "tags": [ + "VirtualEnclave" + ], + "description": "Callback that triggers on approval deletion state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalDeletionCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_ApprovalDeletionCallback": { + "$ref": "./examples/VirtualEnclave_PostApprovalDeletionCallback.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints": { + "get": { + "operationId": "EnclaveEndpoints_ListByEnclaveResource", + "tags": [ + "EnclaveEndpoints" + ], + "description": "List EnclaveEndpointResource resources by EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_ListByEnclaveResource": { + "$ref": "./examples/EnclaveEndpoints_ListByEnclaveResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints/{enclaveEndpointName}": { + "get": { + "operationId": "EnclaveEndpoints_Get", + "tags": [ + "EnclaveEndpoints" + ], + "description": "Get a EnclaveEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "enclaveEndpointName", + "in": "path", + "description": "The name of the Enclave Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_Get": { + "$ref": "./examples/EnclaveEndpoints_Get.json" + } + } + }, + "put": { + "operationId": "EnclaveEndpoints_CreateOrUpdate", + "tags": [ + "EnclaveEndpoints" + ], + "description": "Create a EnclaveEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "enclaveEndpointName", + "in": "path", + "description": "The name of the Enclave Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EnclaveEndpointResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EnclaveEndpointResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResource" + } + }, + "201": { + "description": "Resource 'EnclaveEndpointResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_CreateOrUpdate": { + "$ref": "./examples/EnclaveEndpoints_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EnclaveEndpoints_Update", + "tags": [ + "EnclaveEndpoints" + ], + "description": "Update a EnclaveEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "enclaveEndpointName", + "in": "path", + "description": "The name of the Enclave Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EnclaveEndpointPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_Update": { + "$ref": "./examples/EnclaveEndpoints_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EnclaveEndpoints_Delete", + "tags": [ + "EnclaveEndpoints" + ], + "description": "Delete a EnclaveEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "enclaveEndpointName", + "in": "path", + "description": "The name of the Enclave Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_Delete": { + "$ref": "./examples/EnclaveEndpoints_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints/{enclaveEndpointName}/approvalCallback": { + "post": { + "operationId": "EnclaveEndpoints_ApprovalCallback", + "tags": [ + "EnclaveEndpoints" + ], + "description": "Callback that triggers on approval state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "enclaveEndpointName", + "in": "path", + "description": "The name of the Enclave Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_ApprovalCallback": { + "$ref": "./examples/EnclaveEndpoints_PostApprovalCallback.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints/{enclaveEndpointName}/approvalDeletionCallback": { + "post": { + "operationId": "EnclaveEndpoints_ApprovalDeletionCallback", + "tags": [ + "EnclaveEndpoints" + ], + "description": "Callback that triggers on approval deletion state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "enclaveEndpointName", + "in": "path", + "description": "The name of the Enclave Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalDeletionCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_ApprovalDeletionCallback": { + "$ref": "./examples/EnclaveEndpoints_ApprovalDeletionCallback.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/workloads": { + "get": { + "operationId": "Workload_ListByEnclaveResource", + "tags": [ + "Workload" + ], + "description": "List WorkloadResource resources by EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_ListByEnclaveResource": { + "$ref": "./examples/Workload_ListByEnclaveResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/workloads/{workloadName}": { + "get": { + "operationId": "Workload_Get", + "tags": [ + "Workload" + ], + "description": "Get a WorkloadResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "workloadName", + "in": "path", + "description": "The name of the workloadResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_Get": { + "$ref": "./examples/Workload_Get.json" + } + } + }, + "put": { + "operationId": "Workload_CreateOrUpdate", + "tags": [ + "Workload" + ], + "description": "Create a WorkloadResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "workloadName", + "in": "path", + "description": "The name of the workloadResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'WorkloadResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadResource" + } + }, + "201": { + "description": "Resource 'WorkloadResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_CreateOrUpdate": { + "$ref": "./examples/Workload_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Workload_Update", + "tags": [ + "Workload" + ], + "description": "Update a WorkloadResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "workloadName", + "in": "path", + "description": "The name of the workloadResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_Update": { + "$ref": "./examples/Workload_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Workload_Delete", + "tags": [ + "Workload" + ], + "description": "Delete a WorkloadResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "workloadName", + "in": "path", + "description": "The name of the workloadResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_Delete": { + "$ref": "./examples/Workload_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ActionPerformed": { + "type": "string", + "description": "Specifies the action performed by the approver", + "enum": [ + "Approved", + "Rejected" + ], + "x-ms-enum": { + "name": "ActionPerformed", + "modelAsString": true, + "values": [ + { + "name": "Approved", + "value": "Approved", + "description": "Action was Approved" + }, + { + "name": "Rejected", + "value": "Rejected", + "description": "Action was Rejected" + } + ] + } + }, + "ApprovalActionRequest": { + "type": "object", + "description": "Request body for calling post-action", + "properties": { + "approvalStatus": { + "type": "string", + "description": "Approval status indicating 'Approved' or 'Rejected'", + "enum": [ + "Approved", + "Rejected" + ], + "x-ms-enum": { + "modelAsString": true + } + } + }, + "required": [ + "approvalStatus" + ] + }, + "ApprovalActionResponse": { + "type": "object", + "description": "Response body after handling of approvalCallbackRequest", + "properties": { + "message": { + "type": "string", + "description": "Confirmation message indicating the result of the operation." + } + }, + "required": [ + "message" + ] + }, + "ApprovalCallbackRequest": { + "type": "object", + "description": "Request body for calling post-action", + "properties": { + "resourceRequestAction": { + "type": "string", + "description": "Resource request action indicating action which needed to be performed upon calling approval-callback post action", + "enum": [ + "Create", + "Delete", + "Update", + "Reset" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "approvalStatus": { + "type": "string", + "description": "Approval status indicating 'Approved' or 'Rejected'", + "enum": [ + "Approved", + "Rejected" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "approvalCallbackPayload": { + "type": "string", + "description": "Payload requested by client upon approval action" + } + }, + "required": [ + "resourceRequestAction", + "approvalStatus" + ] + }, + "ApprovalDeletionCallbackRequest": { + "type": "object", + "description": "Request body for calling post-action", + "properties": { + "resourceRequestAction": { + "type": "string", + "description": "Resource request action indicating action which needed to be performed upon calling approval-deletion-callback post action", + "enum": [ + "Create", + "Delete", + "Update" + ], + "x-ms-enum": { + "modelAsString": true + } + } + }, + "required": [ + "resourceRequestAction" + ] + }, + "ApprovalPatchModel": { + "type": "object", + "description": "Approvals patch model.", + "properties": { + "properties": { + "$ref": "#/definitions/ApprovalPatchProperties", + "description": "Approval Patch properties" + } + } + }, + "ApprovalPatchProperties": { + "type": "object", + "description": "Approvals patch properties.", + "properties": { + "parent1": { + "type": "string", + "description": "Parameter for optimizing query results" + }, + "parent2": { + "type": "string", + "description": "Parameter for optimizing query results" + }, + "approvers": { + "type": "array", + "description": "List of approvers for the approval request", + "items": { + "$ref": "#/definitions/Approver" + }, + "x-ms-identifiers": [ + "approverEntraId" + ] + }, + "ticketId": { + "type": "string", + "description": "Ticket ID for the approval request" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "Approval request creation time" + }, + "stateChangedAt": { + "type": "string", + "format": "date-time", + "description": "Approval request state change time, time at which approval request state changed from pending to approved or rejected." + }, + "requestMetadata": { + "$ref": "#/definitions/RequestMetadataUpdatableProperties", + "description": "Request metadata for the approval request." + } + } + }, + "ApprovalPolicy": { + "type": "string", + "description": "Approval Policy.", + "enum": [ + "Required", + "NotRequired" + ], + "x-ms-enum": { + "name": "ApprovalPolicy", + "modelAsString": true, + "values": [ + { + "name": "Required", + "value": "Required", + "description": "Approval will be required for the specified action." + }, + { + "name": "NotRequired", + "value": "NotRequired", + "description": "Approval will not be required for the specified action." + } + ] + } + }, + "ApprovalProperties": { + "type": "object", + "description": "Approval Base model.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + }, + "parent1": { + "type": "string", + "description": "Parameter for optimizing query results" + }, + "parent2": { + "type": "string", + "description": "Parameter for optimizing query results" + }, + "approvers": { + "type": "array", + "description": "List of approvers for the approval request", + "items": { + "$ref": "#/definitions/Approver" + }, + "x-ms-identifiers": [ + "approverEntraId" + ] + }, + "ticketId": { + "type": "string", + "description": "Ticket ID for the approval request" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "Approval request creation time" + }, + "stateChangedAt": { + "type": "string", + "format": "date-time", + "description": "Approval request state change time, time at which approval request state changed from pending to approved or rejected." + }, + "requestMetadata": { + "$ref": "#/definitions/RequestMetadata", + "description": "Request metadata for the approval request." + } + }, + "required": [ + "requestMetadata" + ] + }, + "ApprovalResource": { + "type": "object", + "description": "Approval Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/ApprovalProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ApprovalResourceListResult": { + "type": "object", + "description": "The response of a ApprovalResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ApprovalResource items on this page", + "items": { + "$ref": "#/definitions/ApprovalResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ApprovalSettings": { + "type": "object", + "description": "ApprovalSettings Properties", + "properties": { + "endpointCreation": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for endpoint creation (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "endpointUpdate": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for endpoint update (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "endpointDeletion": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for endpoint deletion (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "connectionCreation": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for enclave connection creation (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "connectionUpdate": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for enclave connection update (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "connectionDeletion": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for enclave connection deletion (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "enclaveCreation": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for virtual enclave creation (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "enclaveDeletion": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for virtual enclave deletion (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "maintenanceMode": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for toggling maintenance mode (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "serviceCatalogDeployment": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for deploying service catalog templates (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "notificationOnApprovalCreation": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Notification will be sent on creation of an Approval Request", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "notificationOnApprovalAction": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Notification will be sent on any action taken (Approve/Reject) on an Approval Request", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "notificationOnApprovalDeletion": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Notification will be sent on deletion of an Approval Request", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "mandatoryApprovers": { + "type": "array", + "description": "List of mandatory approvers for the approval request", + "items": { + "$ref": "#/definitions/MandatoryApprover" + }, + "x-ms-identifiers": [ + "approverEntraId" + ] + }, + "minimumApproversRequired": { + "type": "integer", + "format": "int64", + "description": "Minimum number of approvers required for the approval request", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "ApprovalSettingsPatchProperties": { + "type": "object", + "description": "ApprovalSettings Properties", + "properties": { + "mandatoryApprovers": { + "type": "array", + "description": "List of mandatory approvers for the approval request", + "items": { + "$ref": "#/definitions/MandatoryApprover" + }, + "x-ms-identifiers": [ + "approverEntraId" + ] + } + } + }, + "ApprovalStatus": { + "type": "string", + "description": "Approval Status. It can be Approved, Rejected, Pending, Deleted or Expired.", + "enum": [ + "Approved", + "Rejected", + "Pending", + "Deleted", + "Expired" + ], + "x-ms-enum": { + "name": "ApprovalStatus", + "modelAsString": true, + "values": [ + { + "name": "Approved", + "value": "Approved", + "description": "ApprovalStatus Type Approved" + }, + { + "name": "Rejected", + "value": "Rejected", + "description": "ApprovalStatus Type Rejected" + }, + { + "name": "Pending", + "value": "Pending", + "description": "ApprovalStatus Type Pending" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "ApprovalStatus Type Deleted" + }, + { + "name": "Expired", + "value": "Expired", + "description": "ApprovalStatus Type Expired" + } + ] + } + }, + "Approver": { + "type": "object", + "description": "Approver Metadata for approvals request.", + "properties": { + "approverEntraId": { + "type": "string", + "description": "Entra ObjectID of the approver" + }, + "actionPerformed": { + "$ref": "#/definitions/ActionPerformed", + "description": "Action Performed by approver" + }, + "lastUpdatedAt": { + "type": "string", + "format": "date-time", + "description": "approval request last updated at" + } + }, + "required": [ + "approverEntraId", + "lastUpdatedAt" + ] + }, + "Azure.Core.azureLocation": { + "type": "string", + "description": "Represents an Azure geography region where supported resource providers live." + }, + "Azure.ResourceManager.CommonTypes.ManagedServiceIdentityUpdate": { + "type": "object", + "description": "Managed service identity (system assigned and/or user assigned identities)", + "properties": { + "type": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentityType", + "description": "The type of managed identity assigned to this resource." + }, + "userAssignedIdentities": { + "type": "object", + "description": "The identities assigned to this resource by the user.", + "additionalProperties": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentity", + "x-nullable": true + } + } + } + }, + "CheckAddressSpaceAvailabilityRequest": { + "type": "object", + "description": "Request to the action call to check address space availability.", + "properties": { + "communityResourceId": { + "$ref": "#/definitions/CommunityResourceId", + "description": "Resource Id of the Community" + }, + "enclaveVirtualNetwork": { + "$ref": "#/definitions/EnclaveVirtualNetworkModel", + "description": "Information about the enclave virtual network" + } + }, + "required": [ + "communityResourceId", + "enclaveVirtualNetwork" + ] + }, + "CheckAddressSpaceAvailabilityResponse": { + "type": "object", + "description": "Response of availability of the requested address space.", + "properties": { + "value": { + "type": "boolean", + "description": "Boolean representing whether the address space is available." + } + }, + "required": [ + "value" + ] + }, + "CommunityEndpointDestinationRule": { + "type": "object", + "description": "Base type for destination rules.", + "properties": { + "destinationType": { + "$ref": "#/definitions/DestinationType", + "description": "Destination Type." + }, + "protocols": { + "type": "array", + "description": "Protocols. Options specified by Endpoint Protocol Enum.", + "items": { + "$ref": "#/definitions/CommunityEndpointProtocol" + } + }, + "transitHubResourceId": { + "$ref": "#/definitions/TransitHubResourceId", + "description": "Transit Hub Resource Id." + }, + "name": { + "type": "string", + "description": "Endpoint Rule Name." + }, + "destination": { + "type": "string", + "description": "Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas." + }, + "port": { + "type": "string", + "description": "Port. Can include multiple ports separated by commas or a range indicated by a hyphen." + } + } + }, + "CommunityEndpointPatchModel": { + "type": "object", + "description": "Community Endpoint Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/CommunityEndpointPatchProperties", + "description": "Community Endpoint Patch properties" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CommunityEndpointPatchProperties": { + "type": "object", + "description": "Community Endpoint patchable Properties", + "properties": { + "ruleCollection": { + "type": "array", + "description": "Community Endpoint Rule Collection.", + "items": { + "$ref": "#/definitions/CommunityEndpointDestinationRule" + }, + "x-ms-identifiers": [] + } + } + }, + "CommunityEndpointProperties": { + "type": "object", + "description": "Community Endpoint Resource properties", + "properties": { + "ruleCollection": { + "type": "array", + "description": "Community Endpoint Rule Collection.", + "items": { + "$ref": "#/definitions/CommunityEndpointDestinationRule" + }, + "x-ms-identifiers": [] + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids created by community endpoint.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + } + }, + "required": [ + "ruleCollection" + ] + }, + "CommunityEndpointProtocol": { + "type": "string", + "description": "Community Endpoint Protocol Enum", + "enum": [ + "ANY", + "TCP", + "UDP", + "ICMP", + "ESP", + "AH", + "HTTPS", + "HTTP" + ], + "x-ms-enum": { + "name": "CommunityEndpointProtocol", + "modelAsString": true, + "values": [ + { + "name": "ANY", + "value": "ANY", + "description": "CommunityEndpointProtocol Type ANY" + }, + { + "name": "TCP", + "value": "TCP", + "description": "CommunityEndpointProtocol Type TCP" + }, + { + "name": "UDP", + "value": "UDP", + "description": "CommunityEndpointProtocol Type UDP" + }, + { + "name": "ICMP", + "value": "ICMP", + "description": "CommunityEndpointProtocol Type ICMP" + }, + { + "name": "ESP", + "value": "ESP", + "description": "CommunityEndpointProtocol Type ESP" + }, + { + "name": "AH", + "value": "AH", + "description": "CommunityEndpointProtocol Type AH" + }, + { + "name": "HTTPS", + "value": "HTTPS", + "description": "CommunityEndpointProtocol Type HTTPS" + }, + { + "name": "HTTP", + "value": "HTTP", + "description": "CommunityEndpointProtocol Type HTTP" + } + ] + } + }, + "CommunityEndpointResource": { + "type": "object", + "description": "CommunityEndpoint Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/CommunityEndpointProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CommunityEndpointResourceListResult": { + "type": "object", + "description": "The response of a CommunityEndpointResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CommunityEndpointResource items on this page", + "items": { + "$ref": "#/definitions/CommunityEndpointResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CommunityPatchModel": { + "type": "object", + "description": "Community Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/CommunityPatchProperties", + "description": "Community Patch properties" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.ManagedServiceIdentityUpdate", + "description": "The managed service identities assigned to this resource." + } + } + }, + "CommunityPatchProperties": { + "type": "object", + "description": "Community Resource Properties without default values", + "properties": { + "dnsServers": { + "type": "array", + "description": "DNS Servers.", + "items": { + "type": "string" + } + }, + "governedServiceList": { + "type": "array", + "description": "List of services governed by a community.", + "items": { + "$ref": "#/definitions/GovernedServiceItem" + }, + "x-ms-identifiers": [] + }, + "communityRoleAssignments": { + "type": "array", + "description": "Community role assignments", + "items": { + "$ref": "#/definitions/RoleAssignmentItem" + }, + "x-ms-identifiers": [] + }, + "approvalSettings": { + "$ref": "#/definitions/ApprovalSettingsPatchProperties", + "description": "Approval requirements for various actions on the community's resources." + }, + "maintenanceModeConfiguration": { + "$ref": "#/definitions/MaintenanceModeConfigurationPatchModel", + "description": "Maintenance Mode configuration." + } + } + }, + "CommunityProperties": { + "type": "object", + "description": "Community Resource Properties", + "properties": { + "addressSpace": { + "type": "string", + "description": "Address Space.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dnsServers": { + "type": "array", + "description": "DNS Servers.", + "items": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids created by communities.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "managedResourceGroupConfiguration": { + "$ref": "#/definitions/ManagedResourceGroupConfiguration", + "description": "Managed resource group name.", + "readOnly": true + }, + "governedServiceList": { + "type": "array", + "description": "List of services governed by a community.", + "items": { + "$ref": "#/definitions/GovernedServiceItem" + }, + "x-ms-identifiers": [] + }, + "communityRoleAssignments": { + "type": "array", + "description": "Community role assignments", + "items": { + "$ref": "#/definitions/RoleAssignmentItem" + }, + "x-ms-identifiers": [] + }, + "approvalSettings": { + "$ref": "#/definitions/ApprovalSettings", + "description": "Approval requirements for various actions on the community's resources." + }, + "maintenanceModeConfiguration": { + "$ref": "#/definitions/MaintenanceModeConfigurationModel", + "description": "Maintenance Mode configuration." + } + } + }, + "CommunityResource": { + "type": "object", + "description": "Community Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/CommunityProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CommunityResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Mission/communities" + } + ] + } + }, + "CommunityResourceListResult": { + "type": "object", + "description": "The response of a CommunityResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CommunityResource items on this page", + "items": { + "$ref": "#/definitions/CommunityResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DestinationEndpointResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Mission/virtualEnclaves/enclaveEndpoints" + }, + { + "type": "Microsoft.Mission/communities/communityEndpoints" + } + ] + } + }, + "DestinationType": { + "type": "string", + "description": "Destination Type Enum", + "enum": [ + "FQDN", + "FQDNTag", + "IPAddress", + "PrivateNetwork" + ], + "x-ms-enum": { + "name": "DestinationType", + "modelAsString": true, + "values": [ + { + "name": "FQDN", + "value": "FQDN", + "description": "DestinationType Type FQDN" + }, + { + "name": "FQDNTag", + "value": "FQDNTag", + "description": "DestinationType Type FQDNTag" + }, + { + "name": "IPAddress", + "value": "IPAddress", + "description": "DestinationType Type IPAddress" + }, + { + "name": "PrivateNetwork", + "value": "PrivateNetwork", + "description": "DestinationType Type PrivateNetwork" + } + ] + } + }, + "DiagnosticDestination": { + "type": "string", + "description": "Specifies the destination of where to store diagnostic logs.", + "enum": [ + "CommunityOnly", + "EnclaveOnly", + "Both" + ], + "x-ms-enum": { + "name": "DiagnosticDestination", + "modelAsString": true, + "values": [ + { + "name": "CommunityOnly", + "value": "CommunityOnly", + "description": "DiagnosticDestination Type CommunityOnly" + }, + { + "name": "EnclaveOnly", + "value": "EnclaveOnly", + "description": "DiagnosticDestination Type EnclaveOnly" + }, + { + "name": "Both", + "value": "Both", + "description": "DiagnosticDestination Type Both" + } + ] + } + }, + "EnclaveAddressSpacesModel": { + "type": "object", + "description": "Enclave Address Spaces", + "properties": { + "enclaveAddressSpace": { + "type": "string", + "description": "Enclave Address Space" + }, + "managedAddressSpace": { + "type": "string", + "description": "Managed Address Space" + } + } + }, + "EnclaveConnectionPatchModel": { + "type": "object", + "description": "Enclave Connection Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/EnclaveConnectionPatchProperties", + "description": "Enclave Connection Patch properties" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "EnclaveConnectionPatchProperties": { + "type": "object", + "description": "Enclave Connection patchable Properties", + "properties": { + "sourceCidr": { + "type": "string", + "description": "Source CIDR." + } + } + }, + "EnclaveConnectionProperties": { + "type": "object", + "description": "Enclave Connection Resource properties", + "properties": { + "state": { + "$ref": "#/definitions/EnclaveConnectionState", + "description": "The state of the enclaveConnection.", + "readOnly": true + }, + "communityResourceId": { + "$ref": "#/definitions/CommunityResourceId", + "description": "Community Resource Id.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sourceResourceId": { + "$ref": "#/definitions/EnclaveConnectionSourceResourceId", + "description": "Source Resource Id.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sourceCidr": { + "type": "string", + "description": "Source CIDR." + }, + "ipGroup": { + "$ref": "#/definitions/IPGroupResourceId", + "description": "Source IP group Resource Id.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "destinationEndpointId": { + "$ref": "#/definitions/DestinationEndpointResourceId", + "description": "Destination Endpoint Resource Id.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids modified by enclave Connections.", + "items": { + "type": "string" + }, + "readOnly": true + } + }, + "required": [ + "communityResourceId", + "sourceResourceId", + "destinationEndpointId" + ] + }, + "EnclaveConnectionResource": { + "type": "object", + "description": "EnclaveConnection Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/EnclaveConnectionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EnclaveConnectionResourceListResult": { + "type": "object", + "description": "The response of a EnclaveConnectionResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EnclaveConnectionResource items on this page", + "items": { + "$ref": "#/definitions/EnclaveConnectionResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EnclaveConnectionSourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Mission/virtualEnclaves" + }, + { + "type": "Microsoft.Mission/communities/transitHubs" + } + ] + } + }, + "EnclaveConnectionState": { + "type": "string", + "description": "Specifies the state of the enclave connection.", + "enum": [ + "PendingApproval", + "PendingUpdate", + "Approved", + "Active", + "Failed", + "Connected", + "Disconnected" + ], + "x-ms-enum": { + "name": "EnclaveConnectionState", + "modelAsString": true, + "values": [ + { + "name": "PendingApproval", + "value": "PendingApproval", + "description": "EnclaveConnectionState Type Pending Approval" + }, + { + "name": "PendingUpdate", + "value": "PendingUpdate", + "description": "EnclaveConnectionState Type Pending Update" + }, + { + "name": "Approved", + "value": "Approved", + "description": "EnclaveConnectionState Type Approved" + }, + { + "name": "Active", + "value": "Active", + "description": "EnclaveConnectionState Type Active" + }, + { + "name": "Failed", + "value": "Failed", + "description": "EnclaveConnectionState Type Failed" + }, + { + "name": "Connected", + "value": "Connected", + "description": "EnclaveConnectionState Type Connected" + }, + { + "name": "Disconnected", + "value": "Disconnected", + "description": "EnclaveConnectionState Type Disconnected" + } + ] + } + }, + "EnclaveDefaultSettingsModel": { + "type": "object", + "description": "Virtual Enclave Default Settings", + "properties": { + "keyVaultResourceId": { + "$ref": "#/definitions/KeyVaultResourceId", + "description": "Key Vault Resource Id.", + "readOnly": true + }, + "storageAccountResourceId": { + "$ref": "#/definitions/StorageAccountResourceId", + "description": "Storage Account Resource Id.", + "readOnly": true + }, + "logAnalyticsResourceIdCollection": { + "type": "array", + "description": "Log Analytics Resource Ids.", + "items": { + "$ref": "#/definitions/LogAnalyticsResourceId" + }, + "readOnly": true + }, + "diagnosticDestination": { + "type": "string", + "description": "Diagnostic Destination.", + "default": "EnclaveOnly", + "enum": [ + "CommunityOnly", + "EnclaveOnly", + "Both" + ], + "x-ms-enum": { + "name": "DiagnosticDestination", + "modelAsString": true, + "values": [ + { + "name": "CommunityOnly", + "value": "CommunityOnly", + "description": "DiagnosticDestination Type CommunityOnly" + }, + { + "name": "EnclaveOnly", + "value": "EnclaveOnly", + "description": "DiagnosticDestination Type EnclaveOnly" + }, + { + "name": "Both", + "value": "Both", + "description": "DiagnosticDestination Type Both" + } + ] + } + } + } + }, + "EnclaveDefaultSettingsPatchModel": { + "type": "object", + "description": "Virtual Enclave Default Settings", + "properties": { + "diagnosticDestination": { + "$ref": "#/definitions/DiagnosticDestination", + "description": "Diagnostic Destination." + } + } + }, + "EnclaveEndpointDestinationRule": { + "type": "object", + "description": "Enclave Endpoint Rule Properties", + "properties": { + "protocols": { + "type": "array", + "description": "Protocols. Options specified by Endpoint Protocol Enum.", + "items": { + "$ref": "#/definitions/EnclaveEndpointProtocol" + } + }, + "name": { + "type": "string", + "description": "Endpoint Rule Name." + }, + "destination": { + "type": "string", + "description": "Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas." + }, + "port": { + "type": "string", + "description": "Port. Can include multiple ports separated by commas or a range indicated by a hyphen." + } + } + }, + "EnclaveEndpointPatchModel": { + "type": "object", + "description": "Enclave Endpoint Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/EnclaveEndpointPatchProperties", + "description": "Enclave Endpoint Patch properties" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "EnclaveEndpointPatchProperties": { + "type": "object", + "description": "Enclave Endpoint patchable Properties", + "properties": { + "ruleCollection": { + "type": "array", + "description": "Enclave Endpoint Rule Collection.", + "items": { + "$ref": "#/definitions/EnclaveEndpointDestinationRule" + }, + "x-ms-identifiers": [] + } + } + }, + "EnclaveEndpointProperties": { + "type": "object", + "description": "Enclave Endpoint Resource properties", + "properties": { + "ruleCollection": { + "type": "array", + "description": "Enclave Endpoint Rule Collection.", + "items": { + "$ref": "#/definitions/EnclaveEndpointDestinationRule" + }, + "x-ms-identifiers": [] + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids created by community endpoint.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + } + }, + "required": [ + "ruleCollection" + ] + }, + "EnclaveEndpointProtocol": { + "type": "string", + "description": "Enclave Endpoint Protocol Enum", + "enum": [ + "ANY", + "TCP", + "UDP", + "ICMP", + "ESP", + "AH" + ], + "x-ms-enum": { + "name": "EnclaveEndpointProtocol", + "modelAsString": true, + "values": [ + { + "name": "ANY", + "value": "ANY", + "description": "EndpointProtocol Type ANY" + }, + { + "name": "TCP", + "value": "TCP", + "description": "EndpointProtocol Type TCP" + }, + { + "name": "UDP", + "value": "UDP", + "description": "EndpointProtocol Type UDP" + }, + { + "name": "ICMP", + "value": "ICMP", + "description": "EndpointProtocol Type ICMP" + }, + { + "name": "ESP", + "value": "ESP", + "description": "EndpointProtocol Type ESP" + }, + { + "name": "AH", + "value": "AH", + "description": "EndpointProtocol Type AH" + } + ] + } + }, + "EnclaveEndpointResource": { + "type": "object", + "description": "EnclaveEndpoint Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/EnclaveEndpointProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EnclaveEndpointResourceListResult": { + "type": "object", + "description": "The response of a EnclaveEndpointResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EnclaveEndpointResource items on this page", + "items": { + "$ref": "#/definitions/EnclaveEndpointResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EnclaveResource": { + "type": "object", + "description": "Virtual Enclave Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualEnclaveProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EnclaveResourceListResult": { + "type": "object", + "description": "The response of a EnclaveResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EnclaveResource items on this page", + "items": { + "$ref": "#/definitions/EnclaveResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EnclaveVirtualNetworkModel": { + "type": "object", + "description": "Enclave Virtual Network Properties", + "properties": { + "name": { + "type": "string", + "description": "Network Name." + }, + "networkSize": { + "type": "string", + "description": "Network Size.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "customCidrRange": { + "type": "string", + "description": "Custom CIDR Range.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "subnetConfigurations": { + "type": "array", + "description": "Subnet Configurations.", + "items": { + "$ref": "#/definitions/SubnetConfiguration" + }, + "x-ms-identifiers": [] + }, + "allowSubnetCommunication": { + "type": "boolean", + "description": "Allow Subnet Communication.", + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "connectToAzureServices": { + "type": "boolean", + "description": "Connect to Azure Services (True or False).", + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "GovernedServiceItem": { + "type": "object", + "description": "GovernedServiceItem Properties", + "properties": { + "id": { + "$ref": "#/definitions/ServiceIdentifier", + "description": "Service ID" + }, + "name": { + "type": "string", + "description": "Service name.", + "readOnly": true + }, + "option": { + "type": "string", + "description": "Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable).", + "enum": [ + "Allow", + "Deny", + "ExceptionOnly", + "NotApplicable" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "enforcement": { + "type": "string", + "description": "Initiative enforcement (Enabled or Disabled).", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "auditOnly": { + "type": "boolean", + "description": "Policies set to auditOnly (True or False)." + }, + "initiatives": { + "type": "array", + "description": "Initiatives associated with this service.", + "items": { + "type": "string" + }, + "readOnly": true + } + }, + "required": [ + "id" + ] + }, + "IPGroupResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/IpGroups" + } + ] + } + }, + "KeyVaultResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + } + }, + "LogAnalyticsResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + } + }, + "MaintenanceModeConfigurationModel": { + "type": "object", + "description": "Maintenance Mode", + "properties": { + "mode": { + "type": "string", + "description": "Current mode of Maintenance Mode Configuration", + "default": "Off", + "enum": [ + "On", + "CanNotDelete", + "Off", + "General", + "Advanced" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "principals": { + "type": "array", + "description": "The user, group or service principal object affected by Maintenance Mode", + "default": [], + "items": { + "$ref": "#/definitions/Principal" + } + }, + "justification": { + "type": "string", + "description": "Justification for entering or exiting Maintenance Mode", + "default": "Off", + "enum": [ + "Networking", + "Governance", + "Off" + ], + "x-ms-enum": { + "modelAsString": true + } + } + }, + "required": [ + "mode" + ] + }, + "MaintenanceModeConfigurationPatchModel": { + "type": "object", + "description": "Maintenance Mode Patch Model", + "properties": { + "mode": { + "type": "string", + "description": "Current mode of Maintenance Mode Configuration", + "enum": [ + "On", + "CanNotDelete", + "Off", + "General", + "Advanced" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "principals": { + "type": "array", + "description": "The user, group or service principal object affected by Maintenance Mode", + "items": { + "$ref": "#/definitions/Principal" + } + }, + "justification": { + "type": "string", + "description": "Justification for entering or exiting Maintenance Mode", + "enum": [ + "Networking", + "Governance", + "Off" + ], + "x-ms-enum": { + "modelAsString": true + } + } + } + }, + "ManagedResourceGroupConfiguration": { + "type": "object", + "description": "ManagedResourceGroup related properties", + "properties": { + "name": { + "type": "string", + "description": "Name of managed resource group" + }, + "location": { + "$ref": "#/definitions/Azure.Core.azureLocation", + "description": "The geo-location where the resource lives", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "MandatoryApprover": { + "type": "object", + "description": "Approver Metadata for approvals request.", + "properties": { + "approverEntraId": { + "type": "string", + "description": "EntraId of the approver" + } + }, + "required": [ + "approverEntraId" + ] + }, + "NsgResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/networkSecurityGroups" + } + ] + } + }, + "Principal": { + "type": "object", + "description": "Principal for maintenance mode or role assignments", + "properties": { + "id": { + "type": "string", + "description": "The object id associated with the principal" + }, + "type": { + "type": "string", + "description": "The type of the object id. We currently allow users, groups, and service principals", + "enum": [ + "User", + "Group", + "ServicePrincipal" + ], + "x-ms-enum": { + "modelAsString": true + } + } + }, + "required": [ + "id", + "type" + ] + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning status of the resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Creating", + "Deleting", + "NotSpecified", + "Running", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Provisioning State Type Accepted" + }, + { + "name": "Creating", + "value": "Creating", + "description": "Provisioning State Type Creating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Provisioning State Type Deleting" + }, + { + "name": "NotSpecified", + "value": "NotSpecified", + "description": "Provisioning State Type NotSpecified" + }, + { + "name": "Running", + "value": "Running", + "description": "Provisioning State Type Running" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Provisioning State Type Updating" + } + ] + }, + "readOnly": true + }, + "RequestMetadata": { + "type": "object", + "description": "Request Metadata for approvals request.", + "properties": { + "resourceAction": { + "type": "string", + "description": "Resource Action of the item being approved or declined." + }, + "approvalCallbackRoute": { + "type": "string", + "description": "Route name for the approval callback" + }, + "approvalCallbackPayload": { + "type": "string", + "description": "Payload to be sent upon any action on approval request" + }, + "approvalStatus": { + "type": "string", + "description": "Status of the approval. Uses ApprovalStatus enum.", + "default": "Pending", + "enum": [ + "Approved", + "Rejected", + "Pending", + "Deleted", + "Expired" + ], + "x-ms-enum": { + "name": "ApprovalStatus", + "modelAsString": true, + "values": [ + { + "name": "Approved", + "value": "Approved", + "description": "ApprovalStatus Type Approved" + }, + { + "name": "Rejected", + "value": "Rejected", + "description": "ApprovalStatus Type Rejected" + }, + { + "name": "Pending", + "value": "Pending", + "description": "ApprovalStatus Type Pending" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "ApprovalStatus Type Deleted" + }, + { + "name": "Expired", + "value": "Expired", + "description": "ApprovalStatus Type Expired" + } + ] + } + } + }, + "required": [ + "resourceAction" + ] + }, + "RequestMetadataUpdatableProperties": { + "type": "object", + "description": "Request Metadata patch properties.", + "properties": { + "resourceAction": { + "type": "string", + "description": "Resource Action of the item being approved or declined." + }, + "approvalCallbackRoute": { + "type": "string", + "description": "Route name for the approval callback" + }, + "approvalCallbackPayload": { + "type": "string", + "description": "Payload to be sent upon any action on approval request" + }, + "approvalStatus": { + "$ref": "#/definitions/ApprovalStatus", + "description": "Status of the approval. Uses ApprovalStatus enum." + } + } + }, + "RoleAssignmentItem": { + "type": "object", + "description": "Role assignment item that indicates which principals should be assigned this role definition", + "properties": { + "id": { + "type": "string", + "description": "Role definition identifier" + }, + "principals": { + "type": "array", + "description": "List of principal IDs to which to assign this role definition", + "items": { + "$ref": "#/definitions/Principal" + } + } + }, + "required": [ + "id" + ] + }, + "ServiceIdentifier": { + "type": "string", + "description": "Identifier for governed services.", + "enum": [ + "AKS", + "AppService", + "AzureFirewalls", + "ContainerRegistry", + "CosmosDB", + "DataConnectors", + "Insights", + "KeyVault", + "Logic", + "MicrosoftSQL", + "Monitoring", + "PostgreSQL", + "PrivateDNSZones", + "ServiceBus", + "Storage" + ], + "x-ms-enum": { + "name": "ServiceIdentifier", + "modelAsString": true, + "values": [ + { + "name": "AKS", + "value": "AKS", + "description": "Service identifier for AKS" + }, + { + "name": "AppService", + "value": "AppService", + "description": "Service identifier for App Service" + }, + { + "name": "AzureFirewalls", + "value": "AzureFirewalls", + "description": "Service identifier for Azure Firewalls" + }, + { + "name": "ContainerRegistry", + "value": "ContainerRegistry", + "description": "Service identifier for Container Registry" + }, + { + "name": "CosmosDB", + "value": "CosmosDB", + "description": "Service identifier for CosmosDB" + }, + { + "name": "DataConnectors", + "value": "DataConnectors", + "description": "Service identifier for Data Connectors" + }, + { + "name": "Insights", + "value": "Insights", + "description": "Service identifier for Insights" + }, + { + "name": "KeyVault", + "value": "KeyVault", + "description": "Service identifier for Key Vault" + }, + { + "name": "Logic", + "value": "Logic", + "description": "Service identifier for Logic" + }, + { + "name": "MicrosoftSql", + "value": "MicrosoftSQL", + "description": "Service identifier for Microsoft SQL" + }, + { + "name": "Monitoring", + "value": "Monitoring", + "description": "Service identifier for Monitoring" + }, + { + "name": "PostgreSql", + "value": "PostgreSQL", + "description": "Service identifier for PostgreSQL" + }, + { + "name": "PrivateDNSZones", + "value": "PrivateDNSZones", + "description": "Service identifier for Private DNS Zones" + }, + { + "name": "ServiceBus", + "value": "ServiceBus", + "description": "Service identifier for Service Bus" + }, + { + "name": "Storage", + "value": "Storage", + "description": "Service identifier for Storage" + } + ] + } + }, + "StorageAccountResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + }, + "SubnetConfiguration": { + "type": "object", + "description": "Subnet Configuration", + "properties": { + "name": { + "type": "string", + "description": "Subnet name." + }, + "id": { + "$ref": "#/definitions/SubnetResourceId", + "description": "Subnet Resource ID.", + "readOnly": true + }, + "networkPrefixSize": { + "type": "integer", + "format": "int32", + "description": "Network prefix size." + }, + "subnetDelegation": { + "type": "string", + "description": "Subnet delegation." + }, + "addressPrefix": { + "type": "string", + "description": "Address prefix.", + "readOnly": true + }, + "networkSecurityGroupId": { + "$ref": "#/definitions/NsgResourceId", + "description": "Network security group ID.", + "readOnly": true + } + }, + "required": [ + "name", + "networkPrefixSize" + ] + }, + "SubnetResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "TransitHubPatchModel": { + "type": "object", + "description": "TH Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/TransitHubPatchProperties", + "description": "The TransitHub resource." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TransitHubPatchProperties": { + "type": "object", + "description": "Transit Hub patchable Properties", + "properties": { + "state": { + "$ref": "#/definitions/TransitHubState", + "description": "The state of the transitHub." + }, + "transitOption": { + "$ref": "#/definitions/TransitOption", + "description": "The TransitOption of the transitHub." + } + } + }, + "TransitHubProperties": { + "type": "object", + "description": "Describes the properties of an Transit Hub.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/TransitHubState", + "description": "The state of the transitHub." + }, + "transitOption": { + "$ref": "#/definitions/TransitOption", + "description": "The TransitOption of the transitHub." + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids modified by transitHubs.", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "TransitHubResource": { + "type": "object", + "description": "TransitHub Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/TransitHubProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "TransitHubResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Mission/communities/transitHubs" + } + ] + } + }, + "TransitHubResourceListResult": { + "type": "object", + "description": "The response of a TransitHubResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The TransitHubResource items on this page", + "items": { + "$ref": "#/definitions/TransitHubResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "TransitHubState": { + "type": "string", + "description": "Specifies the state of the transitHub.", + "enum": [ + "PendingApproval", + "Approved", + "PendingUpdate", + "Active", + "Failed" + ], + "x-ms-enum": { + "name": "TransitHubState", + "modelAsString": true, + "values": [ + { + "name": "PendingApproval", + "value": "PendingApproval", + "description": "TransitHubState Type PendingApproval" + }, + { + "name": "Approved", + "value": "Approved", + "description": "TransitHubState Type Approved" + }, + { + "name": "PendingUpdate", + "value": "PendingUpdate", + "description": "TransitHubState Type PendingUpdate" + }, + { + "name": "Active", + "value": "Active", + "description": "TransitHubState Type Active" + }, + { + "name": "Failed", + "value": "Failed", + "description": "TransitHubState Type Failed" + } + ] + } + }, + "TransitOption": { + "type": "object", + "description": "TransitOption Properties", + "properties": { + "type": { + "$ref": "#/definitions/TransitOptionType", + "description": "Transit Option Type." + }, + "params": { + "$ref": "#/definitions/TransitOptionParams", + "description": "Transit Option Params" + } + } + }, + "TransitOptionParams": { + "type": "object", + "description": "TransitOptionParams Properties", + "properties": { + "scaleUnits": { + "type": "integer", + "format": "int64", + "description": "Transit Option Params scaleUnits." + }, + "remoteVirtualNetworkId": { + "$ref": "#/definitions/VirtualNetworkResourceId", + "description": "Transit Option Params remoteVirtualNetworkId." + } + } + }, + "TransitOptionType": { + "type": "string", + "description": "Specifies the type of the transitOption.", + "enum": [ + "ExpressRoute", + "Gateway", + "Peering" + ], + "x-ms-enum": { + "name": "TransitOptionType", + "modelAsString": true, + "values": [ + { + "name": "ExpressRoute", + "value": "ExpressRoute", + "description": "TransitOptionType ExpressRoute" + }, + { + "name": "Gateway", + "value": "Gateway", + "description": "TransitOptionType Gateway" + }, + { + "name": "Peering", + "value": "Peering", + "description": "TransitOptionType Peering" + } + ] + } + }, + "VirtualEnclavePatchModel": { + "type": "object", + "description": "Virtual Enclave Patch Model", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualEnclavePatchProperties", + "description": "Virtual Enclave Patch properties" + }, + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.ManagedServiceIdentityUpdate", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualEnclavePatchProperties": { + "type": "object", + "description": "Virtual Enclave Patchable Properties", + "properties": { + "enclaveVirtualNetwork": { + "$ref": "#/definitions/EnclaveVirtualNetworkModel", + "description": "Virtual Network." + }, + "bastionEnabled": { + "type": "boolean", + "description": "Deploy Bastion service (True or False)." + }, + "enclaveRoleAssignments": { + "type": "array", + "description": "Enclave role assignments", + "items": { + "$ref": "#/definitions/RoleAssignmentItem" + }, + "x-ms-identifiers": [] + }, + "workloadRoleAssignments": { + "type": "array", + "description": "Workload role assignments", + "items": { + "$ref": "#/definitions/RoleAssignmentItem" + }, + "x-ms-identifiers": [] + }, + "enclaveDefaultSettings": { + "$ref": "#/definitions/EnclaveDefaultSettingsPatchModel", + "description": "Enclave default settings." + }, + "maintenanceModeConfiguration": { + "$ref": "#/definitions/MaintenanceModeConfigurationPatchModel", + "description": "Maintenance Mode configuration." + } + } + }, + "VirtualEnclaveProperties": { + "type": "object", + "description": "Virtual Enclave Resource properties", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + }, + "enclaveVirtualNetwork": { + "$ref": "#/definitions/EnclaveVirtualNetworkModel", + "description": "Virtual Network." + }, + "enclaveAddressSpaces": { + "$ref": "#/definitions/EnclaveAddressSpacesModel", + "description": "Enclave Address Spaces", + "readOnly": true + }, + "communityResourceId": { + "$ref": "#/definitions/CommunityResourceId", + "description": "Community Resource Id.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids created by Virtual Enclave.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource." + }, + "readOnly": true + }, + "managedResourceGroupConfiguration": { + "$ref": "#/definitions/ManagedResourceGroupConfiguration", + "description": "Managed resource group name.", + "readOnly": true + }, + "bastionEnabled": { + "type": "boolean", + "description": "Deploy Bastion service (True or False).", + "default": false + }, + "enclaveRoleAssignments": { + "type": "array", + "description": "Enclave role assignments", + "items": { + "$ref": "#/definitions/RoleAssignmentItem" + }, + "x-ms-identifiers": [] + }, + "workloadRoleAssignments": { + "type": "array", + "description": "Workload role assignments", + "items": { + "$ref": "#/definitions/RoleAssignmentItem" + }, + "x-ms-identifiers": [] + }, + "enclaveDefaultSettings": { + "$ref": "#/definitions/EnclaveDefaultSettingsModel", + "description": "Enclave default settings." + }, + "maintenanceModeConfiguration": { + "$ref": "#/definitions/MaintenanceModeConfigurationModel", + "description": "Maintenance Mode configuration." + } + }, + "required": [ + "enclaveVirtualNetwork", + "communityResourceId" + ] + }, + "VirtualNetworkResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks" + } + ] + } + }, + "WorkloadPatchModel": { + "type": "object", + "description": "Workload Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadPatchProperties", + "description": "Workload Patch properties" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "WorkloadPatchProperties": { + "type": "object", + "description": "Workload patchable Properties", + "properties": { + "resourceGroupCollection": { + "type": "array", + "description": "List of resource group ids.", + "items": { + "type": "string" + } + } + } + }, + "WorkloadProperties": { + "type": "object", + "description": "Workload Resource properties", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + }, + "resourceGroupCollection": { + "type": "array", + "description": "List of resource group ids.", + "items": { + "type": "string" + } + } + } + }, + "WorkloadResource": { + "type": "object", + "description": "Workload Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "WorkloadResourceListResult": { + "type": "object", + "description": "The response of a WorkloadResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadResource items on this page", + "items": { + "$ref": "#/definitions/WorkloadResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + } + }, + "parameters": { + "Azure.ResourceManager.ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "description": "The fully qualified Azure Resource manager identifier of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_CreateOrUpdate.json new file mode 100644 index 000000000000..1702fbcb86c0 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_CreateOrUpdate.json @@ -0,0 +1,108 @@ +{ + "title": "Approval_CreateOrUpdate", + "operationId": "Approval_CreateOrUpdate", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "resource": { + "properties": { + "parentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "grandparentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "parentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "grandparentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "parentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "grandparentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_Delete.json new file mode 100644 index 000000000000..a9c7932ab133 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "Approval_Delete", + "operationId": "Approval_Delete", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_Get.json new file mode 100644 index 000000000000..7671d4fcaf26 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_Get.json @@ -0,0 +1,49 @@ +{ + "title": "Approval_Get", + "operationId": "Approval_Get", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "parentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "grandparentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_ListByParent.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_ListByParent.json new file mode 100644 index 000000000000..3731127bccf8 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_ListByParent.json @@ -0,0 +1,54 @@ +{ + "title": "Approval_ListByParent", + "operationId": "Approval_ListByParent", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "parentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "grandparentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_NotifyInitiator.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_NotifyInitiator.json new file mode 100644 index 000000000000..d3d36460b706 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_NotifyInitiator.json @@ -0,0 +1,28 @@ +{ + "title": "Approval_NotifyInitiator", + "operationId": "Approval_NotifyInitiator", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "body": { + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approved" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_Update.json new file mode 100644 index 000000000000..f8e351bad5aa --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Approvals_Update.json @@ -0,0 +1,75 @@ +{ + "title": "Approval_Update", + "operationId": "Approval_Update", + "parameters": { + "resourceUri": "subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "approvalName": "TestApprovals", + "properties": { + "properties": { + "parentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "grandparentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "parentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "grandparentResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "requestMetadata": { + "resourceAction": "string", + "approvalStatus": "Approved", + "approvalCallbackRoute": "approvalCallback", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + }, + "approvers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000", + "actionPerformed": "Approved", + "lastUpdatedAt": "2023-03-17T20:43:17.760Z" + } + ], + "ticketId": "string", + "createdAt": "2023-03-17T20:43:17.760Z", + "stateChangedAt": "2023-03-17T20:43:17.760Z" + }, + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/approvals/TestApprovals", + "name": "TestApprovals", + "type": "Microsoft.Mission/approvals", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_CreateOrUpdate.json new file mode 100644 index 000000000000..f23136d9b04c --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_CreateOrUpdate.json @@ -0,0 +1,101 @@ +{ + "title": "CommunityEndpoints_CreateOrUpdate", + "operationId": "CommunityEndpoints_CreateOrUpdate", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "resource": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "ports": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "ports": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communties/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDNTag", + "destination": "foo.example.com", + "ports": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_Delete.json new file mode 100644 index 000000000000..9ac8f8bc2efa --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "CommunityEndpoints_Delete", + "operationId": "CommunityEndpoints_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_Get.json new file mode 100644 index 000000000000..4b83dff5f614 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_Get.json @@ -0,0 +1,46 @@ +{ + "title": "CommunityEndpoints_Get", + "operationId": "CommunityEndpoints_Get", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "ports": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_HandleApprovalCreation.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_HandleApprovalCreation.json new file mode 100644 index 000000000000..155a47cf5b19 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_HandleApprovalCreation.json @@ -0,0 +1,29 @@ +{ + "operationId": "CommunityEndpoints_HandleApprovalCreation", + "title": "CommunityEndpoints_HandleApprovalCreation", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_HandleApprovalDeletion.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_HandleApprovalDeletion.json new file mode 100644 index 000000000000..375a5696ee50 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_HandleApprovalDeletion.json @@ -0,0 +1,28 @@ +{ + "operationId": "CommunityEndpoints_HandleApprovalDeletion", + "title": "CommunityEndpoints_HandleApprovalDeletion", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_ListByCommunityResource.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_ListByCommunityResource.json new file mode 100644 index 000000000000..51dc1eb1fc53 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_ListByCommunityResource.json @@ -0,0 +1,51 @@ +{ + "title": "CommunityEndpoints_ListByCommunityResource", + "operationId": "CommunityEndpoints_ListByCommunityResource", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "ports": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_ListBySubscription.json new file mode 100644 index 000000000000..0749671de2ae --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_ListBySubscription.json @@ -0,0 +1,50 @@ +{ + "title": "CommunityEndpoints_ListBySubscription", + "operationId": "CommunityEndpoints_ListBySubscription", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "ports": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_Update.json new file mode 100644 index 000000000000..32b15252d104 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/CommunityEndpoints_Update.json @@ -0,0 +1,70 @@ +{ + "title": "CommunityEndpoints_Update", + "operationId": "CommunityEndpoints_Update", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "communityEndpointName": "TestMyCommunityEndpoint", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "ports": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "destinationType": "FQDN", + "destination": "foo.example.com", + "ports": "443", + "protocols": [ + "TCP" + ], + "transitHubResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity/communityendpoints/TestMyCommunityEndpoint", + "name": "TestMyCommunityEndpoint", + "type": "Microsoft.Mission/communities/communityendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_CreateOrUpdate.json new file mode 100644 index 000000000000..3ea457166f98 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_CreateOrUpdate.json @@ -0,0 +1,613 @@ +{ + "title": "Community_CreateOrUpdate", + "operationId": "Community_CreateOrUpdate", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "resource": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "governedServiceList": [ + { + "serviceId": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "AppService", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "ContainerRegistry", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "KeyVault", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "MicrosoftSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "ServiceBus", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "AzureFirewalls", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "PrivateDNSZones", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "DataConnectors", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + } + ], + "communityRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "approvalSettings": { + "endpointCreation": "NotRequired", + "endpointUpdate": "Required", + "endpointDeletion": "NotRequired", + "connectionCreation": "Required", + "connectionUpdate": "Required", + "connectionDeletion": "NotRequired", + "enclaveCreation": "NotRequired", + "enclaveDeletion": "NotRequired", + "maintenanceMode": "NotRequired", + "serviceCatalogDeployment": "NotRequired", + "notificationOnApprovalCreation": "NotRequired", + "notificationOnApprovalAction": "NotRequired", + "notificationOnApprovalDeletion": "NotRequired", + "mandatoryApprovers": [ + { + "approverEntraId": "00000000-0000-0000-0000-000000000000" + } + ], + "minimumApproversRequired": 0 + }, + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "firewallSku": "Standard" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "governedServiceList": [ + { + "serviceId": "AKS", + "serviceName": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "serviceId": "AppService", + "serviceName": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "serviceId": "ContainerRegistry", + "serviceName": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "serviceId": "CosmosDB", + "serviceName": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "serviceId": "KeyVault", + "serviceName": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "serviceId": "MicrosoftSQL", + "serviceName": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "serviceId": "Monitoring", + "serviceName": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "serviceId": "PostgreSQL", + "serviceName": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "serviceId": "ServiceBus", + "serviceName": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "serviceId": "Storage", + "serviceName": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "serviceId": "AzureFirewalls", + "serviceName": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Insights", + "serviceName": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Logic", + "serviceName": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "PrivateDNSZones", + "serviceName": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "DataConnectors", + "serviceName": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + } + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "governedServiceList": [ + { + "serviceId": "AKS", + "serviceName": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "serviceId": "AppService", + "serviceName": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "serviceId": "ContainerRegistry", + "serviceName": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "serviceId": "CosmosDB", + "serviceName": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "serviceId": "KeyVault", + "serviceName": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "serviceId": "MicrosoftSQL", + "serviceName": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "serviceId": "Monitoring", + "serviceName": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "serviceId": "PostgreSQL", + "serviceName": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "serviceId": "ServiceBus", + "serviceName": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "serviceId": "Storage", + "serviceName": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "serviceId": "AzureFirewalls", + "serviceName": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Insights", + "serviceName": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Logic", + "serviceName": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "PrivateDNSZones", + "serviceName": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "DataConnectors", + "serviceName": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + } + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_Delete.json new file mode 100644 index 000000000000..e13386220130 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "Community_Delete", + "operationId": "Community_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_Get.json new file mode 100644 index 000000000000..8516f1251435 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_Get.json @@ -0,0 +1,236 @@ +{ + "title": "Community_Get", + "operationId": "Community_Get", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "managedOnBehalfOfConfiguration": { + "moboBrokerResources": [ + { + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Resources/moboBrokers/bnthrkwfkfeorrzvtdxbfz" + } + ] + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "governedServiceList": [ + { + "serviceId": "AKS", + "serviceName": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "serviceId": "AppService", + "serviceName": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "serviceId": "ContainerRegistry", + "serviceName": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "serviceId": "CosmosDB", + "serviceName": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "serviceId": "KeyVault", + "serviceName": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "serviceId": "MicrosoftSQL", + "serviceName": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "serviceId": "Monitoring", + "serviceName": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "serviceId": "PostgreSQL", + "serviceName": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "serviceId": "ServiceBus", + "serviceName": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "serviceId": "Storage", + "serviceName": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "serviceId": "AzureFirewalls", + "serviceName": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Insights", + "serviceName": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Logic", + "serviceName": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "PrivateDNSZones", + "serviceName": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "DataConnectors", + "serviceName": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "firewallSku": "Standard" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_ListByResourceGroup.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_ListByResourceGroup.json new file mode 100644 index 000000000000..d347bda7c5b6 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_ListByResourceGroup.json @@ -0,0 +1,233 @@ +{ + "title": "Community_ListByResourceGroup", + "operationId": "Community_ListByResourceGroup", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "governedServiceList": [ + { + "serviceId": "AKS", + "serviceName": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "serviceId": "AppService", + "serviceName": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "serviceId": "ContainerRegistry", + "serviceName": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "serviceId": "CosmosDB", + "serviceName": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "serviceId": "KeyVault", + "serviceName": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "serviceId": "MicrosoftSQL", + "serviceName": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "serviceId": "Monitoring", + "serviceName": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "serviceId": "PostgreSQL", + "serviceName": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "serviceId": "ServiceBus", + "serviceName": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "serviceId": "Storage", + "serviceName": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "serviceId": "AzureFirewalls", + "serviceName": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Insights", + "serviceName": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Logic", + "serviceName": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "PrivateDNSZones", + "serviceName": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "DataConnectors", + "serviceName": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "firewallSku": "Standard" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_ListBySubscription.json new file mode 100644 index 000000000000..029b19a271b4 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_ListBySubscription.json @@ -0,0 +1,232 @@ +{ + "title": "Community_ListBySubscription", + "operationId": "Community_ListBySubscription", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "governedServiceList": [ + { + "serviceId": "AKS", + "serviceName": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "serviceId": "AppService", + "serviceName": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "serviceId": "ContainerRegistry", + "serviceName": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "serviceId": "CosmosDB", + "serviceName": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "serviceId": "KeyVault", + "serviceName": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "serviceId": "MicrosoftSQL", + "serviceName": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "serviceId": "Monitoring", + "serviceName": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "serviceId": "PostgreSQL", + "serviceName": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "serviceId": "ServiceBus", + "serviceName": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "serviceId": "Storage", + "serviceName": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "serviceId": "AzureFirewalls", + "serviceName": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Insights", + "serviceName": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Logic", + "serviceName": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "PrivateDNSZones", + "serviceName": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "DataConnectors", + "serviceName": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "firewallSku": "Standard" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_PostCheckAddressSpaceAvailability.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_PostCheckAddressSpaceAvailability.json new file mode 100644 index 000000000000..631ad19dc6d5 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_PostCheckAddressSpaceAvailability.json @@ -0,0 +1,32 @@ +{ + "operationId": "Community_CheckAddressSpaceAvailability", + "title": "Community_CheckAddressSpaceAvailability", + "parameters": { + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "checkAddressSpaceAvailabilityRequest": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true + } + }, + "api-version": "2025-05-01-preview" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": true + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_Update.json new file mode 100644 index 000000000000..d3dc1f69d98b --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Community_Update.json @@ -0,0 +1,358 @@ +{ + "title": "Community_Update", + "operationId": "Community_Update", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "dnsServers": [ + "azure.net" + ], + "governedServiceList": [ + { + "serviceId": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "AppService", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "ContainerRegistry", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "KeyVault", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "MicrosoftSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "ServiceBus", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "AzureFirewalls", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "PrivateDNSZones", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + }, + { + "serviceId": "DataConnectors", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None" + } + ], + "communityRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "addressSpace": "10.0.0.0/24", + "dnsServers": [ + "azure.net" + ], + "provisioningState": "Succeeded", + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "governedServiceList": [ + { + "serviceId": "AKS", + "serviceName": "AKS", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "d300338e-65d1-4be3-b18e-fb4ce5715a8f" + ] + }, + { + "serviceId": "AppService", + "serviceName": "App Service", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "528d78c5-246c-4f26-ade6-d30798705411" + ] + }, + { + "serviceId": "ContainerRegistry", + "serviceName": "Container Registry", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "b3fe25eb-cdc6-475f-96a5-04ac270f630d" + ] + }, + { + "serviceId": "CosmosDB", + "serviceName": "CosmosDB", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "6bd484ca-ae8d-46cf-9b33-e1feef84bfba" + ] + }, + { + "serviceId": "KeyVault", + "serviceName": "Key Vault", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "4f4dba0f-a5ee-494b-8df7-f9727dea6f37" + ] + }, + { + "serviceId": "MicrosoftSQL", + "serviceName": "Microsoft SQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0fbe78a5-1722-4f1b-83a5-89c14151fa60" + ] + }, + { + "serviceId": "Monitoring", + "serviceName": "Monitoring", + "option": "Not Applicable", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "0a9ea1cb-7925-47fc-b0fe-8bb0a8190423" + ] + }, + { + "serviceId": "PostgreSQL", + "serviceName": "PostgreSQL", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "5eaa16b4-81f2-4354-aef3-2d77288e396e" + ] + }, + { + "serviceId": "ServiceBus", + "serviceName": "Service Bus", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "8fcdb3f1-1369-426d-9917-81edfee903ab" + ] + }, + { + "serviceId": "Storage", + "serviceName": "Storage", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [ + "ca122c06-05f6-4423-9018-ccb523168eb2" + ] + }, + { + "serviceId": "AzureFirewalls", + "serviceName": "Azure Firewalls", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Insights", + "serviceName": "Insights", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "Logic", + "serviceName": "Logic", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "PrivateDNSZones", + "serviceName": "Private DNS Zones", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + }, + { + "serviceId": "DataConnectors", + "serviceName": "Data Connectors", + "option": "Allow", + "enforcement": "Enabled", + "policyAction": "None", + "initiatives": [] + } + ], + "communityRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "name": "TestMyCommunity", + "type": "Microsoft.Mission/communities", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_CreateOrUpdate.json new file mode 100644 index 000000000000..412be8b1325c --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_CreateOrUpdate.json @@ -0,0 +1,79 @@ +{ + "title": "EnclaveConnection_CreateOrUpdate", + "operationId": "EnclaveConnection_CreateOrUpdate", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "resource": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_Delete.json new file mode 100644 index 000000000000..5a5016453bd3 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "EnclaveConnection_Delete", + "operationId": "EnclaveConnection_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_Get.json new file mode 100644 index 000000000000..a74c4d9dbd25 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_Get.json @@ -0,0 +1,38 @@ +{ + "title": "EnclaveConnection_Get", + "operationId": "EnclaveConnection_Get", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_HandleApprovalCreation.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_HandleApprovalCreation.json new file mode 100644 index 000000000000..999f24d0bbab --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_HandleApprovalCreation.json @@ -0,0 +1,29 @@ +{ + "operationId": "EnclaveConnection_HandleApprovalCreation", + "title": "EnclaveConnection_HandleApprovalCreation", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_HandleApprovalDeletion.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_HandleApprovalDeletion.json new file mode 100644 index 000000000000..e35266d7164e --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_HandleApprovalDeletion.json @@ -0,0 +1,27 @@ +{ + "operationId": "EnclaveConnection_HandleApprovalDeletion", + "title": "EnclaveConnection_HandleApprovalDeletion", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_ListByResourceGroup.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_ListByResourceGroup.json new file mode 100644 index 000000000000..95b5e5871696 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_ListByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "title": "EnclaveConnection_ListByResourceGroup", + "operationId": "EnclaveConnection_ListByResourceGroup", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_ListBySubscription.json new file mode 100644 index 000000000000..8c13c3e5dde0 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_ListBySubscription.json @@ -0,0 +1,42 @@ +{ + "title": "EnclaveConnection_ListBySubscription", + "operationId": "EnclaveConnection_ListBySubscription", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "enclaveConnectionName": "TestMyEnclaveConnection" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_Update.json new file mode 100644 index 000000000000..2b57864d6245 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveConnection_Update.json @@ -0,0 +1,52 @@ +{ + "title": "EnclaveConnection_Update", + "operationId": "EnclaveConnection_Update", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "enclaveConnectionName": "TestMyEnclaveConnection", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "sourceCidr": "10.0.0.0/24" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity", + "sourceResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "sourceCidr": "10.0.0.0/24", + "destinationEndpointId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/enclaveconnections/TestMyEnclaveConnection", + "name": "TestMyEnclaveConnection", + "type": "Microsoft.Mission/enclaveconnections", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_CreateOrUpdate.json new file mode 100644 index 000000000000..4e149d60df2b --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_CreateOrUpdate.json @@ -0,0 +1,98 @@ +{ + "title": "EnclaveEndpoints_CreateOrUpdate", + "operationId": "EnclaveEndpoints_CreateOrUpdate", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "resource": { + "properties": { + "ruleCollection": [ + { + "endpointRuleName": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "ports": "443", + "protocols": [ + "TCP" + ] + } + ] + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "endpointRuleName": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "ports": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "ruleCollection": [ + { + "endpointRuleName": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "ports": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_Delete.json new file mode 100644 index 000000000000..377e34864838 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "EnclaveEndpoints_Delete", + "operationId": "EnclaveEndpoints_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_Get.json new file mode 100644 index 000000000000..5145968a4a03 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_Get.json @@ -0,0 +1,45 @@ +{ + "title": "EnclaveEndpoints_Get", + "operationId": "EnclaveEndpoints_Get", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint" + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "endpointRuleName": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "ports": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_HandleApprovalCreation.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_HandleApprovalCreation.json new file mode 100644 index 000000000000..28b0bde02d9d --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_HandleApprovalCreation.json @@ -0,0 +1,29 @@ +{ + "operationId": "EnclaveEndpoints_HandleApprovalCreation", + "title": "EnclaveEndpoints_HandleApprovalCreation", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_HandleApprovalDeletion.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_HandleApprovalDeletion.json new file mode 100644 index 000000000000..91e93563ca47 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_HandleApprovalDeletion.json @@ -0,0 +1,28 @@ +{ + "operationId": "EnclaveEndpoints_HandleApprovalDeletion", + "title": "EnclaveEndpoints_HandleApprovalDeletion", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_ListByEnclaveResource.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_ListByEnclaveResource.json new file mode 100644 index 000000000000..b87b85c3241f --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_ListByEnclaveResource.json @@ -0,0 +1,49 @@ +{ + "title": "EnclaveEndpoints_ListByEnclaveResource", + "operationId": "EnclaveEndpoints_ListByEnclaveResource", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "endpointRuleName": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "ports": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_ListBySubscription.json new file mode 100644 index 000000000000..1e21c255c11f --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "title": "EnclaveEndpoints_ListBySubscription", + "operationId": "EnclaveEndpoints_ListBySubscription", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ruleCollection": [ + { + "endpointRuleName": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "ports": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_Update.json new file mode 100644 index 000000000000..00af3b9261d1 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/EnclaveEndpoints_Update.json @@ -0,0 +1,68 @@ +{ + "title": "EnclaveEndpoints_Update", + "operationId": "EnclaveEndpoints_Update", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "73CEECEF-2C30-488E-946F-D20F414D99BA", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "enclaveEndpointName": "TestMyEnclaveEndpoint", + "location": "westcentralus", + "properties": { + "tags": { + "sampletag": "samplevalue" + }, + "properties": { + "ruleCollection": [ + { + "endpointRuleName": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "ports": "443", + "protocols": [ + "TCP" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ruleCollection": [ + { + "endpointRuleName": "54CEECEF-2C30-488E-946F-D20F414D99BA", + "destination": "10.0.0.0/24", + "ports": "443", + "protocols": [ + "TCP" + ] + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "sampletag": "samplevalue" + }, + "location": "West US", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/virtualenclaves/TestMyEnclave/enclaveendpoints/TestMyEnclaveEndpoint", + "name": "TestMyEnclaveEndpoint", + "type": "Microsoft.Mission/virtualenclaves/enclaveendpoints", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Operations_List.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..c393ee7b2148 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Operations_List.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2025-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "kribdpoznbvrjci", + "isDataAction": true, + "display": { + "provider": "usvnnruysydqdpwj", + "resource": "lrdjzltcbeoljosqrw", + "operation": "vdnitexr", + "description": "valid description goes here" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_CreateOrUpdate.json new file mode 100644 index 000000000000..0cf707c42dff --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_CreateOrUpdate.json @@ -0,0 +1,95 @@ +{ + "title": "TransitHub_CreateOrUpdate", + "operationId": "TransitHub_CreateOrUpdate", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName", + "resource": { + "properties": { + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + } + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "zwwdhidevngwzo", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_Delete.json new file mode 100644 index 000000000000..c341fc33825b --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "TransitHub_Delete", + "operationId": "TransitHub_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_Get.json new file mode 100644 index 000000000000..6ef54f041dc8 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_Get.json @@ -0,0 +1,45 @@ +{ + "title": "TransitHub_Get", + "operationId": "TransitHub_Get", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_ListByCommunityResource.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_ListByCommunityResource.json new file mode 100644 index 000000000000..f32c8c97ef9c --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_ListByCommunityResource.json @@ -0,0 +1,49 @@ +{ + "title": "TransitHub_ListByCommunityResource", + "operationId": "TransitHub_ListByCommunityResource", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithub", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_ListBySubscription.json new file mode 100644 index 000000000000..ab6b7cb7d621 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "title": "TransitHub_ListBySubscription", + "operationId": "TransitHub_ListBySubscription", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "communityName": "TestMyCommunity" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_Update.json new file mode 100644 index 000000000000..f4ae5d09155d --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/TransitHub_Update.json @@ -0,0 +1,65 @@ +{ + "title": "TransitHub_Update", + "operationId": "TransitHub_Update", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "communityName": "TestMyCommunity", + "transitHubName": "TestThName", + "location": "westcentralus", + "properties": { + "tags": { + "key4278": "hjoxhwofxcshowbnafdrrzq" + }, + "properties": { + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "PendingApproval", + "transitOption": { + "type": "ExpressRoute", + "params": { + "scaleUnits": 1 + } + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName", + "name": "TestThName", + "type": "microsoft.mission/communities/transithubs", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_CreateOrUpdate.json new file mode 100644 index 000000000000..1e90860e1a5e --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_CreateOrUpdate.json @@ -0,0 +1,319 @@ +{ + "title": "VirtualEnclave_CreateOrUpdate", + "operationId": "VirtualEnclave_CreateOrUpdate", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "resource": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "diagnosticDestination": "Both" + }, + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "roleDefinitionId": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "roleDefinitionId": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "roleDefinitionId": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "roleDefinitionId": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "roleDefinitionId": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "roleDefinitionId": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_Delete.json new file mode 100644 index 000000000000..e42f4937e9e9 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "VirtualEnclave_Delete", + "operationId": "VirtualEnclave_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_Get.json new file mode 100644 index 000000000000..a92b51d65224 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_Get.json @@ -0,0 +1,135 @@ +{ + "title": "VirtualEnclave_Get", + "operationId": "VirtualEnclave_Get", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "subnetResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true + }, + "managedOnBehalfOfConfiguration": { + "moboBrokerResources": [ + { + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Resources/moboBrokers/bnthrkwfkfeorrzvtdxbfz" + } + ] + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "roleDefinitionId": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "roleDefinitionId": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_HandleApprovalCreation.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_HandleApprovalCreation.json new file mode 100644 index 000000000000..a6c2b68c3e93 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_HandleApprovalCreation.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualEnclave_HandleApprovalCreation", + "title": "VirtualEnclave_HandleApprovalCreation", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "body": { + "resourceRequestAction": "Create", + "approvalStatus": "Approved", + "approvalCallbackPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_HandleApprovalDeletion.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_HandleApprovalDeletion.json new file mode 100644 index 000000000000..00339b028b6f --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_HandleApprovalDeletion.json @@ -0,0 +1,27 @@ +{ + "operationId": "VirtualEnclave_HandleApprovalDeletion", + "title": "VirtualEnclave_HandleApprovalDeletion", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "body": { + "resourceRequestAction": "Create" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "message": "Approval state change handled successfully." + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_ListByResourceGroup.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_ListByResourceGroup.json new file mode 100644 index 000000000000..0dd4e5d4668d --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_ListByResourceGroup.json @@ -0,0 +1,132 @@ +{ + "title": "VirtualEnclave_ListByResourceGroup", + "operationId": "VirtualEnclave_ListByResourceGroup", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "subnetResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "roleDefinitionId": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "roleDefinitionId": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_ListBySubscription.json new file mode 100644 index 000000000000..5f87a97bc6bd --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_ListBySubscription.json @@ -0,0 +1,131 @@ +{ + "title": "VirtualEnclave_ListBySubscription", + "operationId": "VirtualEnclave_ListBySubscription", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "subnetResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "networkPrefixSize": 26, + "addressPrefix": "10.0.0.0/26", + "networkSecurityGroupResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "subnetDelegation": null + } + ], + "allowSubnetCommunication": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "roleDefinitionId": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "roleDefinitionId": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_Update.json new file mode 100644 index 000000000000..46b15bbf5498 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/VirtualEnclave_Update.json @@ -0,0 +1,214 @@ +{ + "title": "VirtualEnclave_Update", + "operationId": "VirtualEnclave_Update", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "westcentralus", + "properties": { + "tags": { + "Tag1": "Value1" + }, + "properties": { + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true + }, + "enclaveDefaultSettings": { + "diagnosticDestination": "Both" + }, + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "roleDefinitionId": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "roleDefinitionId": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "f4aa4954-a564-4933-a7e1-502019d807c2", + "clientId": "b82bf757-ee7f-4632-9df1-5e52a720fdd2" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "enclaveVirtualNetwork": { + "networkSize": "small", + "customCidrRange": "10.0.0.0/24", + "subnetConfigurations": [ + { + "subnetName": "test", + "networkPrefixSize": 26 + } + ], + "allowSubnetCommunication": true + }, + "communityResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity", + "enclaveDefaultSettings": { + "keyVaultResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.KeyVault/vaults/TestMyKeyVault1", + "storageAccountResourceId": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Storage/storageAccounts/TestMyStorageAccount", + "logAnalyticsResourceIdCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA1", + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.OperationalInsights/workspaces/TestMyLogA2" + ], + "diagnosticDestination": "Both" + }, + "resourceCollection": [ + "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg" + ], + "maintenanceModeConfiguration": { + "mode": "Off", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ], + "justification": "Off" + }, + "bastionEnabled": true, + "enclaveRoleAssignments": [ + { + "roleDefinitionId": "b24988ac-6180-42a0-ab88-20f7382dd24c", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + }, + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c0", + "type": "User" + } + ] + }, + { + "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9", + "principals": [ + { + "id": "355a6bb0-abc0-4cba-000d-12a345b678c9", + "type": "User" + } + ] + } + ], + "workloadRoleAssignments": [ + { + "roleDefinitionId": "d73bb868-a0df-4d4d-bd69-98a00b01fccb", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + }, + { + "roleDefinitionId": "fb879df8-f326-4884-b1cf-06f3ad86be52", + "principals": [ + { + "id": "01234567-89ab-ef01-2345-0123456789ab", + "type": "Group" + } + ] + } + ] + }, + "tags": { + "Tag1": "Value1" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave", + "name": "TestMyEnclave", + "type": "microsoft.mission/virtualenclaves", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_CreateOrUpdate.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_CreateOrUpdate.json new file mode 100644 index 000000000000..6f0ac2af23e6 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_CreateOrUpdate.json @@ -0,0 +1,71 @@ +{ + "title": "Workload_CreateOrUpdate", + "operationId": "Workload_CreateOrUpdate", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload", + "resource": { + "properties": { + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_Delete.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_Delete.json new file mode 100644 index 000000000000..dc54a34b75e2 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_Delete.json @@ -0,0 +1,25 @@ +{ + "title": "Workload_Delete", + "operationId": "Workload_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Server": "nginx/1.21.6", + "Date": "Sat, 03 Dec 2022 01:39:21 GMT", + "Content-Length": "0", + "Connection": "keep-alive", + "x-ms-providerhub-traffic": "True", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000", + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_Get.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_Get.json new file mode 100644 index 000000000000..00425fbfb254 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_Get.json @@ -0,0 +1,45 @@ +{ + "title": "Workload_Get", + "operationId": "Workload_Get", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ], + "managedOnBehalfOfConfiguration": { + "moboBrokerResources": [ + { + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Resources/moboBrokers/bnthrkwfkfeorrzvtdxbfz" + } + ] + } + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_ListByEnclaveResource.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_ListByEnclaveResource.json new file mode 100644 index 000000000000..5dc42879932f --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_ListByEnclaveResource.json @@ -0,0 +1,42 @@ +{ + "title": "Workload_ListByEnclaveResource", + "operationId": "Workload_ListByEnclaveResource", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_ListBySubscription.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_ListBySubscription.json new file mode 100644 index 000000000000..c477c14af071 --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "title": "Workload_ListBySubscription", + "operationId": "Workload_ListBySubscription", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "virtualEnclaveName": "TestMyEnclave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_Update.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_Update.json new file mode 100644 index 000000000000..22e96a7e53dc --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/examples/Workload_Update.json @@ -0,0 +1,54 @@ +{ + "title": "Workload_Update", + "operationId": "Workload_Update", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "CA1CB369-DD26-4DB2-9D43-9AFEF0F22093", + "resourceGroupName": "rgopenapi", + "virtualEnclaveName": "TestMyEnclave", + "workloadName": "TestMyWorkload", + "location": "westcentralus", + "properties": { + "tags": { + "key9465": "cylmdprdhhwpcdxpynwostvzytkryj" + }, + "properties": { + "resourceGroupCollection": [ + "g" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceGroupCollection": [ + "g" + ] + }, + "tags": { + "TestKey": "TestValue" + }, + "location": "westcentralus", + "id": "/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/virtualenclaves/TestMyEnclave/workloads/kxzylwqnmxtivpmupnlho", + "name": "kxzylwqnmxtivpmupnlho", + "type": "microsoft.mission/virtualenclaves/workloads", + "systemData": { + "createdBy": "myAlias", + "createdByType": "User", + "createdAt": "2023-03-17T20:43:17.760Z", + "lastModifiedBy": "myAlias", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-03-17T20:43:17.760Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/openapi.json b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/openapi.json new file mode 100644 index 000000000000..1d3bc30aa01c --- /dev/null +++ b/specification/mission/resource-manager/Microsoft.Mission/preview/2025-05-01-preview/openapi.json @@ -0,0 +1,6328 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Mission", + "version": "2025-05-01-preview", + "description": "Microsoft Mission Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Workload" + }, + { + "name": "VirtualEnclave" + }, + { + "name": "Community" + }, + { + "name": "TransitHub" + }, + { + "name": "EnclaveConnection" + }, + { + "name": "EnclaveEndpoints" + }, + { + "name": "CommunityEndpoints" + }, + { + "name": "Approval" + } + ], + "paths": { + "/{resourceUri}/providers/Microsoft.Mission/approvals": { + "get": { + "operationId": "Approval_ListByParent", + "tags": [ + "Approval" + ], + "description": "List ApprovalResource resources by parent", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_ListByParent": { + "$ref": "./examples/Approvals_ListByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.Mission/approvals/{approvalName}": { + "get": { + "operationId": "Approval_Get", + "tags": [ + "Approval" + ], + "description": "Get a ApprovalResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "approvalName", + "in": "path", + "description": "The name of the approvals resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_Get": { + "$ref": "./examples/Approvals_Get.json" + } + } + }, + "put": { + "operationId": "Approval_CreateOrUpdate", + "tags": [ + "Approval" + ], + "description": "Create a ApprovalResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "approvalName", + "in": "path", + "description": "The name of the approvals resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ApprovalResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/ApprovalResource" + } + }, + "201": { + "description": "Resource 'ApprovalResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/ApprovalResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_CreateOrUpdate": { + "$ref": "./examples/Approvals_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Approval_Update", + "tags": [ + "Approval" + ], + "description": "Update a ApprovalResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "approvalName", + "in": "path", + "description": "The name of the approvals resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_Update": { + "$ref": "./examples/Approvals_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Approval_Delete", + "tags": [ + "Approval" + ], + "description": "Delete a ApprovalResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "approvalName", + "in": "path", + "description": "The name of the approvals resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_Delete": { + "$ref": "./examples/Approvals_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.Mission/approvals/{approvalName}/notifyInitiator": { + "post": { + "operationId": "Approval_NotifyInitiator", + "tags": [ + "Approval" + ], + "description": "Upon receiving approval or rejection from approver, this facilitates actions on approval resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "approvalName", + "in": "path", + "description": "The name of the approvals resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalActionRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approval_NotifyInitiator": { + "$ref": "./examples/Approvals_NotifyInitiator.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.Mission/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/communities": { + "get": { + "operationId": "Community_ListBySubscription", + "tags": [ + "Community" + ], + "description": "List CommunityResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_ListBySubscription": { + "$ref": "./examples/Community_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints": { + "get": { + "operationId": "CommunityEndpoints_ListBySubscription", + "tags": [ + "CommunityEndpoints" + ], + "description": "List CommunityEndpointResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityEndpointResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_ListBySubscription": { + "$ref": "./examples/CommunityEndpoints_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/communities/{communityName}/transitHubs": { + "get": { + "operationId": "TransitHub_ListBySubscription", + "tags": [ + "TransitHub" + ], + "description": "List TransitHubResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TransitHubResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_ListBySubscription": { + "$ref": "./examples/TransitHub_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/enclaveConnections": { + "get": { + "operationId": "EnclaveConnection_ListBySubscription", + "tags": [ + "EnclaveConnection" + ], + "description": "List EnclaveConnectionResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_ListBySubscription": { + "$ref": "./examples/EnclaveConnection_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/virtualEnclaves": { + "get": { + "operationId": "VirtualEnclave_ListBySubscription", + "tags": [ + "VirtualEnclave" + ], + "description": "List EnclaveResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_ListBySubscription": { + "$ref": "./examples/VirtualEnclave_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints": { + "get": { + "operationId": "EnclaveEndpoints_ListBySubscription", + "tags": [ + "EnclaveEndpoints" + ], + "description": "List EnclaveEndpointResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_ListBySubscription": { + "$ref": "./examples/EnclaveEndpoints_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/workloads": { + "get": { + "operationId": "Workload_ListBySubscription", + "tags": [ + "Workload" + ], + "description": "List WorkloadResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_ListBySubscription": { + "$ref": "./examples/Workload_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities": { + "get": { + "operationId": "Community_ListByResourceGroup", + "tags": [ + "Community" + ], + "description": "List CommunityResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_ListByResourceGroup": { + "$ref": "./examples/Community_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}": { + "get": { + "operationId": "Community_Get", + "tags": [ + "Community" + ], + "description": "Get a CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_Get": { + "$ref": "./examples/Community_Get.json" + } + } + }, + "put": { + "operationId": "Community_CreateOrUpdate", + "tags": [ + "Community" + ], + "description": "Create a CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunityResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CommunityResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/CommunityResource" + } + }, + "201": { + "description": "Resource 'CommunityResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/CommunityResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_CreateOrUpdate": { + "$ref": "./examples/Community_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Community_Update", + "tags": [ + "Community" + ], + "description": "Update a CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunityPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_Update": { + "$ref": "./examples/Community_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Community_Delete", + "tags": [ + "Community" + ], + "description": "Delete a CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_Delete": { + "$ref": "./examples/Community_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/checkAddressSpaceAvailability": { + "post": { + "operationId": "Community_CheckAddressSpaceAvailability", + "tags": [ + "Community" + ], + "description": "Checks that the IP Address Space to be allocated for this Community is available.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "checkAddressSpaceAvailabilityRequest", + "in": "body", + "description": "Check IP Address Space request body.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckAddressSpaceAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CheckAddressSpaceAvailabilityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Community_CheckAddressSpaceAvailability": { + "$ref": "./examples/Community_PostCheckAddressSpaceAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints": { + "get": { + "operationId": "CommunityEndpoints_ListByCommunityResource", + "tags": [ + "CommunityEndpoints" + ], + "description": "List CommunityEndpointResource resources by CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityEndpointResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_ListByCommunityResource": { + "$ref": "./examples/CommunityEndpoints_ListByCommunityResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints/{communityEndpointName}": { + "get": { + "operationId": "CommunityEndpoints_Get", + "tags": [ + "CommunityEndpoints" + ], + "description": "Get a CommunityEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "communityEndpointName", + "in": "path", + "description": "The name of the Community Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityEndpointResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_Get": { + "$ref": "./examples/CommunityEndpoints_Get.json" + } + } + }, + "put": { + "operationId": "CommunityEndpoints_CreateOrUpdate", + "tags": [ + "CommunityEndpoints" + ], + "description": "Create a CommunityEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "communityEndpointName", + "in": "path", + "description": "The name of the Community Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunityEndpointResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CommunityEndpointResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/CommunityEndpointResource" + } + }, + "201": { + "description": "Resource 'CommunityEndpointResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/CommunityEndpointResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_CreateOrUpdate": { + "$ref": "./examples/CommunityEndpoints_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CommunityEndpoints_Update", + "tags": [ + "CommunityEndpoints" + ], + "description": "Update a CommunityEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "communityEndpointName", + "in": "path", + "description": "The name of the Community Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunityEndpointPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunityEndpointResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_Update": { + "$ref": "./examples/CommunityEndpoints_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CommunityEndpoints_Delete", + "tags": [ + "CommunityEndpoints" + ], + "description": "Delete a CommunityEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "communityEndpointName", + "in": "path", + "description": "The name of the Community Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_Delete": { + "$ref": "./examples/CommunityEndpoints_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints/{communityEndpointName}/handleApprovalCreation": { + "post": { + "operationId": "CommunityEndpoints_HandleApprovalCreation", + "tags": [ + "CommunityEndpoints" + ], + "description": "Callback that triggers on approval state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "communityEndpointName", + "in": "path", + "description": "The name of the Community Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_HandleApprovalCreation": { + "$ref": "./examples/CommunityEndpoints_HandleApprovalCreation.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints/{communityEndpointName}/handleApprovalDeletion": { + "post": { + "operationId": "CommunityEndpoints_HandleApprovalDeletion", + "tags": [ + "CommunityEndpoints" + ], + "description": "Callback that triggers on approval deletion state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "communityEndpointName", + "in": "path", + "description": "The name of the Community Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalDeletionCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CommunityEndpoints_HandleApprovalDeletion": { + "$ref": "./examples/CommunityEndpoints_HandleApprovalDeletion.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/transitHubs": { + "get": { + "operationId": "TransitHub_ListByCommunityResource", + "tags": [ + "TransitHub" + ], + "description": "List TransitHubResource resources by CommunityResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TransitHubResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_ListByCommunityResource": { + "$ref": "./examples/TransitHub_ListByCommunityResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/transitHubs/{transitHubName}": { + "get": { + "operationId": "TransitHub_Get", + "tags": [ + "TransitHub" + ], + "description": "Get a TransitHubResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "transitHubName", + "in": "path", + "description": "The name of the TransitHub Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TransitHubResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_Get": { + "$ref": "./examples/TransitHub_Get.json" + } + } + }, + "put": { + "operationId": "TransitHub_CreateOrUpdate", + "tags": [ + "TransitHub" + ], + "description": "Create a TransitHubResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "transitHubName", + "in": "path", + "description": "The name of the TransitHub Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TransitHubResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'TransitHubResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/TransitHubResource" + } + }, + "201": { + "description": "Resource 'TransitHubResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/TransitHubResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_CreateOrUpdate": { + "$ref": "./examples/TransitHub_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "TransitHub_Update", + "tags": [ + "TransitHub" + ], + "description": "Update a TransitHubResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "transitHubName", + "in": "path", + "description": "The name of the TransitHub Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/TransitHubPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TransitHubResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_Update": { + "$ref": "./examples/TransitHub_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "TransitHub_Delete", + "tags": [ + "TransitHub" + ], + "description": "Delete a TransitHubResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communityName", + "in": "path", + "description": "The name of the communityResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "transitHubName", + "in": "path", + "description": "The name of the TransitHub Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransitHub_Delete": { + "$ref": "./examples/TransitHub_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections": { + "get": { + "operationId": "EnclaveConnection_ListByResourceGroup", + "tags": [ + "EnclaveConnection" + ], + "description": "List EnclaveConnectionResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_ListByResourceGroup": { + "$ref": "./examples/EnclaveConnection_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections/{enclaveConnectionName}": { + "get": { + "operationId": "EnclaveConnection_Get", + "tags": [ + "EnclaveConnection" + ], + "description": "Get a EnclaveConnectionResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_Get": { + "$ref": "./examples/EnclaveConnection_Get.json" + } + } + }, + "put": { + "operationId": "EnclaveConnection_CreateOrUpdate", + "tags": [ + "EnclaveConnection" + ], + "description": "Create a EnclaveConnectionResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EnclaveConnectionResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EnclaveConnectionResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResource" + } + }, + "201": { + "description": "Resource 'EnclaveConnectionResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_CreateOrUpdate": { + "$ref": "./examples/EnclaveConnection_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EnclaveConnection_Update", + "tags": [ + "EnclaveConnection" + ], + "description": "Update a EnclaveConnectionResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EnclaveConnectionPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveConnectionResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_Update": { + "$ref": "./examples/EnclaveConnection_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EnclaveConnection_Delete", + "tags": [ + "EnclaveConnection" + ], + "description": "Delete a EnclaveConnectionResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_Delete": { + "$ref": "./examples/EnclaveConnection_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections/{enclaveConnectionName}/handleApprovalCreation": { + "post": { + "operationId": "EnclaveConnection_HandleApprovalCreation", + "tags": [ + "EnclaveConnection" + ], + "description": "Callback that triggers on approval state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_HandleApprovalCreation": { + "$ref": "./examples/EnclaveConnection_HandleApprovalCreation.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections/{enclaveConnectionName}/handleApprovalDeletion": { + "post": { + "operationId": "EnclaveConnection_HandleApprovalDeletion", + "tags": [ + "EnclaveConnection" + ], + "description": "Callback that triggers on approval deletion state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enclaveConnectionName", + "in": "path", + "description": "The name of the Enclave Connection Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalDeletionCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveConnection_HandleApprovalDeletion": { + "$ref": "./examples/EnclaveConnection_HandleApprovalDeletion.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves": { + "get": { + "operationId": "VirtualEnclave_ListByResourceGroup", + "tags": [ + "VirtualEnclave" + ], + "description": "List EnclaveResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_ListByResourceGroup": { + "$ref": "./examples/VirtualEnclave_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}": { + "get": { + "operationId": "VirtualEnclave_Get", + "tags": [ + "VirtualEnclave" + ], + "description": "Get a EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_Get": { + "$ref": "./examples/VirtualEnclave_Get.json" + } + } + }, + "put": { + "operationId": "VirtualEnclave_CreateOrUpdate", + "tags": [ + "VirtualEnclave" + ], + "description": "Create a EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EnclaveResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EnclaveResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveResource" + } + }, + "201": { + "description": "Resource 'EnclaveResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_CreateOrUpdate": { + "$ref": "./examples/VirtualEnclave_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VirtualEnclave_Update", + "tags": [ + "VirtualEnclave" + ], + "description": "Update a EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualEnclavePatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_Update": { + "$ref": "./examples/VirtualEnclave_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualEnclave_Delete", + "tags": [ + "VirtualEnclave" + ], + "description": "Delete a EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_Delete": { + "$ref": "./examples/VirtualEnclave_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints": { + "get": { + "operationId": "EnclaveEndpoints_ListByEnclaveResource", + "tags": [ + "EnclaveEndpoints" + ], + "description": "List EnclaveEndpointResource resources by EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_ListByEnclaveResource": { + "$ref": "./examples/EnclaveEndpoints_ListByEnclaveResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints/{enclaveEndpointName}": { + "get": { + "operationId": "EnclaveEndpoints_Get", + "tags": [ + "EnclaveEndpoints" + ], + "description": "Get a EnclaveEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "enclaveEndpointName", + "in": "path", + "description": "The name of the Enclave Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_Get": { + "$ref": "./examples/EnclaveEndpoints_Get.json" + } + } + }, + "put": { + "operationId": "EnclaveEndpoints_CreateOrUpdate", + "tags": [ + "EnclaveEndpoints" + ], + "description": "Create a EnclaveEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "enclaveEndpointName", + "in": "path", + "description": "The name of the Enclave Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EnclaveEndpointResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EnclaveEndpointResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResource" + } + }, + "201": { + "description": "Resource 'EnclaveEndpointResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_CreateOrUpdate": { + "$ref": "./examples/EnclaveEndpoints_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EnclaveEndpoints_Update", + "tags": [ + "EnclaveEndpoints" + ], + "description": "Update a EnclaveEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "enclaveEndpointName", + "in": "path", + "description": "The name of the Enclave Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EnclaveEndpointPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnclaveEndpointResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_Update": { + "$ref": "./examples/EnclaveEndpoints_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EnclaveEndpoints_Delete", + "tags": [ + "EnclaveEndpoints" + ], + "description": "Delete a EnclaveEndpointResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "enclaveEndpointName", + "in": "path", + "description": "The name of the Enclave Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_Delete": { + "$ref": "./examples/EnclaveEndpoints_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints/{enclaveEndpointName}/handleApprovalCreation": { + "post": { + "operationId": "EnclaveEndpoints_HandleApprovalCreation", + "tags": [ + "EnclaveEndpoints" + ], + "description": "Callback that triggers on approval state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "enclaveEndpointName", + "in": "path", + "description": "The name of the Enclave Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_HandleApprovalCreation": { + "$ref": "./examples/EnclaveEndpoints_HandleApprovalCreation.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints/{enclaveEndpointName}/handleApprovalDeletion": { + "post": { + "operationId": "EnclaveEndpoints_HandleApprovalDeletion", + "tags": [ + "EnclaveEndpoints" + ], + "description": "Callback that triggers on approval deletion state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "enclaveEndpointName", + "in": "path", + "description": "The name of the Enclave Endpoint Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalDeletionCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnclaveEndpoints_HandleApprovalDeletion": { + "$ref": "./examples/EnclaveEndpoints_HandleApprovalDeletion.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/handleApprovalCreation": { + "post": { + "operationId": "VirtualEnclave_HandleApprovalCreation", + "tags": [ + "VirtualEnclave" + ], + "description": "Callback that triggers on approval state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_HandleApprovalCreation": { + "$ref": "./examples/VirtualEnclave_HandleApprovalCreation.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/handleApprovalDeletion": { + "post": { + "operationId": "VirtualEnclave_HandleApprovalDeletion", + "tags": [ + "VirtualEnclave" + ], + "description": "Callback that triggers on approval deletion state change.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApprovalDeletionCallbackRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApprovalActionResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualEnclave_HandleApprovalDeletion": { + "$ref": "./examples/VirtualEnclave_HandleApprovalDeletion.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/workloads": { + "get": { + "operationId": "Workload_ListByEnclaveResource", + "tags": [ + "Workload" + ], + "description": "List WorkloadResource resources by EnclaveResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_ListByEnclaveResource": { + "$ref": "./examples/Workload_ListByEnclaveResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/workloads/{workloadName}": { + "get": { + "operationId": "Workload_Get", + "tags": [ + "Workload" + ], + "description": "Get a WorkloadResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "workloadName", + "in": "path", + "description": "The name of the workloadResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_Get": { + "$ref": "./examples/Workload_Get.json" + } + } + }, + "put": { + "operationId": "Workload_CreateOrUpdate", + "tags": [ + "Workload" + ], + "description": "Create a WorkloadResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "workloadName", + "in": "path", + "description": "The name of the workloadResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'WorkloadResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadResource" + } + }, + "201": { + "description": "Resource 'WorkloadResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_CreateOrUpdate": { + "$ref": "./examples/Workload_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Workload_Update", + "tags": [ + "Workload" + ], + "description": "Update a WorkloadResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "workloadName", + "in": "path", + "description": "The name of the workloadResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadPatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_Update": { + "$ref": "./examples/Workload_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Workload_Delete", + "tags": [ + "Workload" + ], + "description": "Delete a WorkloadResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualEnclaveName", + "in": "path", + "description": "The name of the enclaveResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + { + "name": "workloadName", + "in": "path", + "description": "The name of the workloadResource Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workload_Delete": { + "$ref": "./examples/Workload_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ActionPerformed": { + "type": "string", + "description": "Specifies the action performed by the approver", + "enum": [ + "Approved", + "Rejected" + ], + "x-ms-enum": { + "name": "ActionPerformed", + "modelAsString": true, + "values": [ + { + "name": "Approved", + "value": "Approved", + "description": "Action was Approved" + }, + { + "name": "Rejected", + "value": "Rejected", + "description": "Action was Rejected" + } + ] + } + }, + "ApprovalActionRequest": { + "type": "object", + "description": "Request body for calling post-action", + "properties": { + "approvalStatus": { + "type": "string", + "description": "Approval status indicating 'Approved' or 'Rejected'", + "enum": [ + "Approved", + "Rejected" + ], + "x-ms-enum": { + "modelAsString": true + } + } + }, + "required": [ + "approvalStatus" + ] + }, + "ApprovalActionResponse": { + "type": "object", + "description": "Response body after handling of approvalCallbackRequest", + "properties": { + "message": { + "type": "string", + "description": "Confirmation message indicating the result of the operation." + } + }, + "required": [ + "message" + ] + }, + "ApprovalCallbackRequest": { + "type": "object", + "description": "Request body for calling post-action", + "properties": { + "resourceRequestAction": { + "type": "string", + "description": "Resource request action indicating action which needed to be performed upon calling approval-callback post action", + "enum": [ + "Create", + "Delete", + "Update", + "Reset" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "approvalStatus": { + "type": "string", + "description": "Approval status indicating 'Approved' or 'Rejected'", + "enum": [ + "Approved", + "Rejected" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "approvalCallbackPayload": { + "type": "string", + "description": "Payload requested by client upon approval action" + } + }, + "required": [ + "resourceRequestAction", + "approvalStatus" + ] + }, + "ApprovalDeletionCallbackRequest": { + "type": "object", + "description": "Request body for calling post-action", + "properties": { + "resourceRequestAction": { + "type": "string", + "description": "Resource request action indicating action which needed to be performed upon calling approval-deletion-callback post action", + "enum": [ + "Create", + "Delete", + "Update" + ], + "x-ms-enum": { + "modelAsString": true + } + } + }, + "required": [ + "resourceRequestAction" + ] + }, + "ApprovalPatchModel": { + "type": "object", + "description": "Approvals patch model.", + "properties": { + "properties": { + "$ref": "#/definitions/ApprovalPatchProperties", + "description": "Approval Patch properties" + } + } + }, + "ApprovalPatchProperties": { + "type": "object", + "description": "Approvals patch properties.", + "properties": { + "parentResourceId": { + "type": "string", + "format": "arm-id", + "description": "Parameter for optimizing query results" + }, + "grandparentResourceId": { + "type": "string", + "format": "arm-id", + "description": "Parameter for optimizing query results" + }, + "approvers": { + "type": "array", + "description": "List of approvers for the approval request", + "items": { + "$ref": "#/definitions/Approver" + }, + "x-ms-identifiers": [ + "approverEntraId" + ] + }, + "ticketId": { + "type": "string", + "description": "Ticket ID for the approval request" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "Approval request creation time" + }, + "stateChangedAt": { + "type": "string", + "format": "date-time", + "description": "Approval request state change time, time at which approval request state changed from pending to approved or rejected." + }, + "requestMetadata": { + "$ref": "#/definitions/RequestMetadataUpdatableProperties", + "description": "Request metadata for the approval request." + } + } + }, + "ApprovalPolicy": { + "type": "string", + "description": "Approval Policy.", + "enum": [ + "Required", + "NotRequired" + ], + "x-ms-enum": { + "name": "ApprovalPolicy", + "modelAsString": true, + "values": [ + { + "name": "Required", + "value": "Required", + "description": "Approval will be required for the specified action." + }, + { + "name": "NotRequired", + "value": "NotRequired", + "description": "Approval will not be required for the specified action." + } + ] + } + }, + "ApprovalProperties": { + "type": "object", + "description": "Approval Base model.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + }, + "parentResourceId": { + "type": "string", + "format": "arm-id", + "description": "Parameter for optimizing query results" + }, + "grandparentResourceId": { + "type": "string", + "format": "arm-id", + "description": "Parameter for optimizing query results" + }, + "approvers": { + "type": "array", + "description": "List of approvers for the approval request", + "items": { + "$ref": "#/definitions/Approver" + }, + "x-ms-identifiers": [ + "approverEntraId" + ] + }, + "ticketId": { + "type": "string", + "description": "Ticket ID for the approval request" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "Approval request creation time" + }, + "stateChangedAt": { + "type": "string", + "format": "date-time", + "description": "Approval request state change time, time at which approval request state changed from pending to approved or rejected." + }, + "requestMetadata": { + "$ref": "#/definitions/RequestMetadata", + "description": "Request metadata for the approval request." + } + }, + "required": [ + "requestMetadata" + ] + }, + "ApprovalResource": { + "type": "object", + "description": "Approval Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/ApprovalProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ApprovalResourceListResult": { + "type": "object", + "description": "The response of a ApprovalResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ApprovalResource items on this page", + "items": { + "$ref": "#/definitions/ApprovalResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ApprovalSettings": { + "type": "object", + "description": "ApprovalSettings Properties", + "properties": { + "endpointCreation": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for endpoint creation (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "endpointUpdate": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for endpoint update (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "endpointDeletion": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for endpoint deletion (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "connectionCreation": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for enclave connection creation (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "connectionUpdate": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for enclave connection update (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "connectionDeletion": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for enclave connection deletion (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "enclaveCreation": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for virtual enclave creation (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "enclaveDeletion": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for virtual enclave deletion (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "maintenanceMode": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for toggling maintenance mode (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "serviceCatalogDeployment": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Approval required for deploying service catalog templates (Required or NotRequired).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "notificationOnApprovalCreation": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Notification will be sent on creation of an Approval Request", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "notificationOnApprovalAction": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Notification will be sent on any action taken (Approve/Reject) on an Approval Request", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "notificationOnApprovalDeletion": { + "$ref": "#/definitions/ApprovalPolicy", + "description": "Notification will be sent on deletion of an Approval Request", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "mandatoryApprovers": { + "type": "array", + "description": "List of mandatory approvers for the approval request", + "items": { + "$ref": "#/definitions/MandatoryApprover" + }, + "x-ms-identifiers": [ + "approverEntraId" + ] + }, + "minimumApproversRequired": { + "type": "integer", + "format": "int64", + "description": "Minimum number of approvers required for the approval request", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "ApprovalSettingsPatchProperties": { + "type": "object", + "description": "ApprovalSettings Properties", + "properties": { + "mandatoryApprovers": { + "type": "array", + "description": "List of mandatory approvers for the approval request", + "items": { + "$ref": "#/definitions/MandatoryApprover" + }, + "x-ms-identifiers": [ + "approverEntraId" + ] + } + } + }, + "ApprovalStatus": { + "type": "string", + "description": "Approval Status. It can be Approved, Rejected, Pending, Deleted or Expired.", + "enum": [ + "Approved", + "Rejected", + "Pending", + "Deleted", + "Expired" + ], + "x-ms-enum": { + "name": "ApprovalStatus", + "modelAsString": true, + "values": [ + { + "name": "Approved", + "value": "Approved", + "description": "ApprovalStatus Type Approved" + }, + { + "name": "Rejected", + "value": "Rejected", + "description": "ApprovalStatus Type Rejected" + }, + { + "name": "Pending", + "value": "Pending", + "description": "ApprovalStatus Type Pending" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "ApprovalStatus Type Deleted" + }, + { + "name": "Expired", + "value": "Expired", + "description": "ApprovalStatus Type Expired" + } + ] + } + }, + "Approver": { + "type": "object", + "description": "Approver Metadata for approvals request.", + "properties": { + "approverEntraId": { + "type": "string", + "description": "Entra ObjectID of the approver" + }, + "actionPerformed": { + "$ref": "#/definitions/ActionPerformed", + "description": "Action Performed by approver" + }, + "lastUpdatedAt": { + "type": "string", + "format": "date-time", + "description": "approval request last updated at" + } + }, + "required": [ + "approverEntraId", + "lastUpdatedAt" + ] + }, + "Azure.ResourceManager.CommonTypes.ManagedServiceIdentityUpdate": { + "type": "object", + "description": "Managed service identity (system assigned and/or user assigned identities)", + "properties": { + "type": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentityType", + "description": "The type of managed identity assigned to this resource." + }, + "userAssignedIdentities": { + "type": "object", + "description": "The identities assigned to this resource by the user.", + "additionalProperties": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentity", + "x-nullable": true + } + } + } + }, + "CheckAddressSpaceAvailabilityRequest": { + "type": "object", + "description": "Request to the action call to check address space availability.", + "properties": { + "communityResourceId": { + "$ref": "#/definitions/CommunityResourceId", + "description": "Resource Id of the Community" + }, + "enclaveVirtualNetwork": { + "$ref": "#/definitions/EnclaveVirtualNetworkModel", + "description": "Information about the enclave virtual network" + } + }, + "required": [ + "communityResourceId", + "enclaveVirtualNetwork" + ] + }, + "CheckAddressSpaceAvailabilityResponse": { + "type": "object", + "description": "Response of availability of the requested address space.", + "properties": { + "value": { + "type": "boolean", + "description": "Boolean representing whether the address space is available." + } + }, + "required": [ + "value" + ] + }, + "CommunityEndpointDestinationRule": { + "type": "object", + "description": "Base type for destination rules.", + "properties": { + "destinationType": { + "$ref": "#/definitions/DestinationType", + "description": "Destination Type." + }, + "protocols": { + "type": "array", + "description": "Protocols. Options specified by Endpoint Protocol Enum.", + "items": { + "$ref": "#/definitions/CommunityEndpointProtocol" + } + }, + "transitHubResourceId": { + "$ref": "#/definitions/TransitHubResourceId", + "description": "Transit Hub Resource Id." + }, + "endpointRuleName": { + "type": "string", + "description": "Endpoint Rule Name." + }, + "destination": { + "type": "string", + "description": "Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas." + }, + "ports": { + "type": "string", + "description": "Port. Can include multiple ports separated by commas or a range indicated by a hyphen." + } + } + }, + "CommunityEndpointPatchModel": { + "type": "object", + "description": "Community Endpoint Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/CommunityEndpointPatchProperties", + "description": "Community Endpoint Patch properties" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CommunityEndpointPatchProperties": { + "type": "object", + "description": "Community Endpoint patchable Properties", + "properties": { + "ruleCollection": { + "type": "array", + "description": "Community Endpoint Rule Collection.", + "items": { + "$ref": "#/definitions/CommunityEndpointDestinationRule" + }, + "x-ms-identifiers": [] + } + } + }, + "CommunityEndpointProperties": { + "type": "object", + "description": "Community Endpoint Resource properties", + "properties": { + "ruleCollection": { + "type": "array", + "description": "Community Endpoint Rule Collection.", + "items": { + "$ref": "#/definitions/CommunityEndpointDestinationRule" + }, + "x-ms-identifiers": [] + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids created by community endpoint.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource." + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + } + }, + "required": [ + "ruleCollection" + ] + }, + "CommunityEndpointProtocol": { + "type": "string", + "description": "Community Endpoint Protocol Enum", + "enum": [ + "ANY", + "TCP", + "UDP", + "ICMP", + "ESP", + "AH", + "HTTPS", + "HTTP" + ], + "x-ms-enum": { + "name": "CommunityEndpointProtocol", + "modelAsString": true, + "values": [ + { + "name": "ANY", + "value": "ANY", + "description": "CommunityEndpointProtocol Type ANY" + }, + { + "name": "TCP", + "value": "TCP", + "description": "CommunityEndpointProtocol Type TCP" + }, + { + "name": "UDP", + "value": "UDP", + "description": "CommunityEndpointProtocol Type UDP" + }, + { + "name": "ICMP", + "value": "ICMP", + "description": "CommunityEndpointProtocol Type ICMP" + }, + { + "name": "ESP", + "value": "ESP", + "description": "CommunityEndpointProtocol Type ESP" + }, + { + "name": "AH", + "value": "AH", + "description": "CommunityEndpointProtocol Type AH" + }, + { + "name": "HTTPS", + "value": "HTTPS", + "description": "CommunityEndpointProtocol Type HTTPS" + }, + { + "name": "HTTP", + "value": "HTTP", + "description": "CommunityEndpointProtocol Type HTTP" + } + ] + } + }, + "CommunityEndpointResource": { + "type": "object", + "description": "CommunityEndpoint Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/CommunityEndpointProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CommunityEndpointResourceListResult": { + "type": "object", + "description": "The response of a CommunityEndpointResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CommunityEndpointResource items on this page", + "items": { + "$ref": "#/definitions/CommunityEndpointResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CommunityPatchModel": { + "type": "object", + "description": "Community Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/CommunityPatchProperties", + "description": "Community Patch properties" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.ManagedServiceIdentityUpdate", + "description": "The managed service identities assigned to this resource." + } + } + }, + "CommunityPatchProperties": { + "type": "object", + "description": "Community Resource Properties without default values", + "properties": { + "dnsServers": { + "type": "array", + "description": "DNS Servers.", + "items": { + "type": "string" + } + }, + "governedServiceList": { + "type": "array", + "description": "List of services governed by a community.", + "items": { + "$ref": "#/definitions/GovernedServiceItem" + }, + "x-ms-identifiers": [] + }, + "policyOverride": { + "type": "string", + "description": "Policy override setting for the community. Specifies whether to apply enclave-specific policies or disable policy enforcement.", + "enum": [ + "Enclave", + "None" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "communityRoleAssignments": { + "type": "array", + "description": "Community role assignments", + "items": { + "$ref": "#/definitions/RoleAssignmentItem" + }, + "x-ms-identifiers": [] + }, + "firewallSku": { + "$ref": "#/definitions/FirewallSKU", + "description": "SKU of the community's Azure Firewall (Basic, Standard, Premium). Standard is the default" + }, + "approvalSettings": { + "$ref": "#/definitions/ApprovalSettingsPatchProperties", + "description": "Approval requirements for various actions on the community's resources." + }, + "maintenanceModeConfiguration": { + "$ref": "#/definitions/MaintenanceModeConfigurationPatchModel", + "description": "Maintenance Mode configuration." + } + } + }, + "CommunityProperties": { + "type": "object", + "description": "Community Resource Properties", + "properties": { + "addressSpace": { + "type": "string", + "description": "Address Space.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dnsServers": { + "type": "array", + "description": "DNS Servers.", + "items": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids created by communities.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource." + }, + "readOnly": true + }, + "managedResourceGroupName": { + "type": "string", + "description": "Managed resource group name.", + "readOnly": true + }, + "managedOnBehalfOfConfiguration": { + "$ref": "../../../../../common-types/resource-management/v5/mobo.json#/definitions/ManagedOnBehalfOfConfiguration", + "description": "Managed On Behalf Of Configuration.", + "readOnly": true + }, + "governedServiceList": { + "type": "array", + "description": "List of services governed by a community.", + "items": { + "$ref": "#/definitions/GovernedServiceItem" + }, + "x-ms-identifiers": [] + }, + "policyOverride": { + "type": "string", + "description": "Policy override setting for the community. Specifies whether to apply enclave-specific policies or disable policy enforcement.", + "enum": [ + "Enclave", + "None" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "communityRoleAssignments": { + "type": "array", + "description": "Community role assignments", + "items": { + "$ref": "#/definitions/RoleAssignmentItem" + }, + "x-ms-identifiers": [] + }, + "firewallSku": { + "type": "string", + "description": "SKU of the community's Azure Firewall (Basic, Standard, Premium). Standard is the default", + "default": "Standard", + "enum": [ + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "FirewallSKU", + "modelAsString": true, + "values": [ + { + "name": "Basic", + "value": "Basic", + "description": "FirewallSKU Basic" + }, + { + "name": "Standard", + "value": "Standard", + "description": "FirwallSKU Standard" + }, + { + "name": "Premium", + "value": "Premium", + "description": "FirewallSKU Premium" + } + ] + } + }, + "approvalSettings": { + "$ref": "#/definitions/ApprovalSettings", + "description": "Approval requirements for various actions on the community's resources." + }, + "maintenanceModeConfiguration": { + "$ref": "#/definitions/MaintenanceModeConfigurationModel", + "description": "Maintenance Mode configuration." + } + } + }, + "CommunityResource": { + "type": "object", + "description": "Community Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/CommunityProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CommunityResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Mission/communities" + } + ] + } + }, + "CommunityResourceListResult": { + "type": "object", + "description": "The response of a CommunityResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CommunityResource items on this page", + "items": { + "$ref": "#/definitions/CommunityResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DestinationEndpointResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Mission/virtualEnclaves/enclaveEndpoints" + }, + { + "type": "Microsoft.Mission/communities/communityEndpoints" + } + ] + } + }, + "DestinationType": { + "type": "string", + "description": "Destination Type Enum", + "enum": [ + "FQDN", + "FQDNTag", + "IPAddress", + "PrivateNetwork" + ], + "x-ms-enum": { + "name": "DestinationType", + "modelAsString": true, + "values": [ + { + "name": "FQDN", + "value": "FQDN", + "description": "DestinationType Type FQDN" + }, + { + "name": "FQDNTag", + "value": "FQDNTag", + "description": "DestinationType Type FQDNTag" + }, + { + "name": "IPAddress", + "value": "IPAddress", + "description": "DestinationType Type IPAddress" + }, + { + "name": "PrivateNetwork", + "value": "PrivateNetwork", + "description": "DestinationType Type PrivateNetwork" + } + ] + } + }, + "DiagnosticDestination": { + "type": "string", + "description": "Specifies the destination of where to store diagnostic logs.", + "enum": [ + "CommunityOnly", + "EnclaveOnly", + "Both" + ], + "x-ms-enum": { + "name": "DiagnosticDestination", + "modelAsString": true, + "values": [ + { + "name": "CommunityOnly", + "value": "CommunityOnly", + "description": "DiagnosticDestination Type CommunityOnly" + }, + { + "name": "EnclaveOnly", + "value": "EnclaveOnly", + "description": "DiagnosticDestination Type EnclaveOnly" + }, + { + "name": "Both", + "value": "Both", + "description": "DiagnosticDestination Type Both" + } + ] + } + }, + "EnclaveAddressSpacesModel": { + "type": "object", + "description": "Enclave Address Spaces", + "properties": { + "enclaveAddressSpace": { + "type": "string", + "description": "Enclave Address Space" + }, + "managedAddressSpace": { + "type": "string", + "description": "Managed Address Space" + } + } + }, + "EnclaveConnectionPatchModel": { + "type": "object", + "description": "Enclave Connection Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/EnclaveConnectionPatchProperties", + "description": "Enclave Connection Patch properties" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "EnclaveConnectionPatchProperties": { + "type": "object", + "description": "Enclave Connection patchable Properties", + "properties": { + "sourceCidr": { + "type": "string", + "description": "Source CIDR." + } + } + }, + "EnclaveConnectionProperties": { + "type": "object", + "description": "Enclave Connection Resource properties", + "properties": { + "state": { + "$ref": "#/definitions/EnclaveConnectionState", + "description": "The state of the enclaveConnection.", + "readOnly": true + }, + "communityResourceId": { + "$ref": "#/definitions/CommunityResourceId", + "description": "Community Resource Id.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sourceResourceId": { + "$ref": "#/definitions/EnclaveConnectionSourceResourceId", + "description": "Source Resource Id.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sourceCidr": { + "type": "string", + "description": "Source CIDR." + }, + "destinationEndpointId": { + "$ref": "#/definitions/DestinationEndpointResourceId", + "description": "Destination Endpoint Resource Id.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids modified by enclave Connections.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource." + }, + "readOnly": true + } + }, + "required": [ + "communityResourceId", + "sourceResourceId", + "destinationEndpointId" + ] + }, + "EnclaveConnectionResource": { + "type": "object", + "description": "EnclaveConnection Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/EnclaveConnectionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EnclaveConnectionResourceListResult": { + "type": "object", + "description": "The response of a EnclaveConnectionResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EnclaveConnectionResource items on this page", + "items": { + "$ref": "#/definitions/EnclaveConnectionResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EnclaveConnectionSourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Mission/virtualEnclaves" + }, + { + "type": "Microsoft.Mission/communities/transitHubs" + } + ] + } + }, + "EnclaveConnectionState": { + "type": "string", + "description": "Specifies the state of the enclave connection.", + "enum": [ + "PendingApproval", + "PendingUpdate", + "Approved", + "Active", + "Failed", + "Connected", + "Disconnected" + ], + "x-ms-enum": { + "name": "EnclaveConnectionState", + "modelAsString": true, + "values": [ + { + "name": "PendingApproval", + "value": "PendingApproval", + "description": "EnclaveConnectionState Type Pending Approval" + }, + { + "name": "PendingUpdate", + "value": "PendingUpdate", + "description": "EnclaveConnectionState Type Pending Update" + }, + { + "name": "Approved", + "value": "Approved", + "description": "EnclaveConnectionState Type Approved" + }, + { + "name": "Active", + "value": "Active", + "description": "EnclaveConnectionState Type Active" + }, + { + "name": "Failed", + "value": "Failed", + "description": "EnclaveConnectionState Type Failed" + }, + { + "name": "Connected", + "value": "Connected", + "description": "EnclaveConnectionState Type Connected" + }, + { + "name": "Disconnected", + "value": "Disconnected", + "description": "EnclaveConnectionState Type Disconnected" + } + ] + } + }, + "EnclaveDefaultSettingsModel": { + "type": "object", + "description": "Virtual Enclave Default Settings", + "properties": { + "keyVaultResourceId": { + "$ref": "#/definitions/KeyVaultResourceId", + "description": "Key Vault Resource Id.", + "readOnly": true + }, + "storageAccountResourceId": { + "$ref": "#/definitions/StorageAccountResourceId", + "description": "Storage Account Resource Id.", + "readOnly": true + }, + "logAnalyticsResourceIdCollection": { + "type": "array", + "description": "Log Analytics Resource Ids.", + "items": { + "$ref": "#/definitions/LogAnalyticsResourceId" + }, + "readOnly": true + }, + "diagnosticDestination": { + "type": "string", + "description": "Diagnostic Destination.", + "default": "EnclaveOnly", + "enum": [ + "CommunityOnly", + "EnclaveOnly", + "Both" + ], + "x-ms-enum": { + "name": "DiagnosticDestination", + "modelAsString": true, + "values": [ + { + "name": "CommunityOnly", + "value": "CommunityOnly", + "description": "DiagnosticDestination Type CommunityOnly" + }, + { + "name": "EnclaveOnly", + "value": "EnclaveOnly", + "description": "DiagnosticDestination Type EnclaveOnly" + }, + { + "name": "Both", + "value": "Both", + "description": "DiagnosticDestination Type Both" + } + ] + } + } + } + }, + "EnclaveDefaultSettingsPatchModel": { + "type": "object", + "description": "Virtual Enclave Default Settings", + "properties": { + "diagnosticDestination": { + "$ref": "#/definitions/DiagnosticDestination", + "description": "Diagnostic Destination." + } + } + }, + "EnclaveEndpointDestinationRule": { + "type": "object", + "description": "Enclave Endpoint Rule Properties", + "properties": { + "protocols": { + "type": "array", + "description": "Protocols. Options specified by Endpoint Protocol Enum.", + "items": { + "$ref": "#/definitions/EnclaveEndpointProtocol" + } + }, + "endpointRuleName": { + "type": "string", + "description": "Endpoint Rule Name." + }, + "destination": { + "type": "string", + "description": "Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas." + }, + "ports": { + "type": "string", + "description": "Port. Can include multiple ports separated by commas or a range indicated by a hyphen." + } + } + }, + "EnclaveEndpointPatchModel": { + "type": "object", + "description": "Enclave Endpoint Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/EnclaveEndpointPatchProperties", + "description": "Enclave Endpoint Patch properties" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "EnclaveEndpointPatchProperties": { + "type": "object", + "description": "Enclave Endpoint patchable Properties", + "properties": { + "ruleCollection": { + "type": "array", + "description": "Enclave Endpoint Rule Collection.", + "items": { + "$ref": "#/definitions/EnclaveEndpointDestinationRule" + }, + "x-ms-identifiers": [] + } + } + }, + "EnclaveEndpointProperties": { + "type": "object", + "description": "Enclave Endpoint Resource properties", + "properties": { + "ruleCollection": { + "type": "array", + "description": "Enclave Endpoint Rule Collection.", + "items": { + "$ref": "#/definitions/EnclaveEndpointDestinationRule" + }, + "x-ms-identifiers": [] + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids created by community endpoint.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource." + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + } + }, + "required": [ + "ruleCollection" + ] + }, + "EnclaveEndpointProtocol": { + "type": "string", + "description": "Enclave Endpoint Protocol Enum", + "enum": [ + "ANY", + "TCP", + "UDP", + "ICMP", + "ESP", + "AH" + ], + "x-ms-enum": { + "name": "EnclaveEndpointProtocol", + "modelAsString": true, + "values": [ + { + "name": "ANY", + "value": "ANY", + "description": "EndpointProtocol Type ANY" + }, + { + "name": "TCP", + "value": "TCP", + "description": "EndpointProtocol Type TCP" + }, + { + "name": "UDP", + "value": "UDP", + "description": "EndpointProtocol Type UDP" + }, + { + "name": "ICMP", + "value": "ICMP", + "description": "EndpointProtocol Type ICMP" + }, + { + "name": "ESP", + "value": "ESP", + "description": "EndpointProtocol Type ESP" + }, + { + "name": "AH", + "value": "AH", + "description": "EndpointProtocol Type AH" + } + ] + } + }, + "EnclaveEndpointResource": { + "type": "object", + "description": "EnclaveEndpoint Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/EnclaveEndpointProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EnclaveEndpointResourceListResult": { + "type": "object", + "description": "The response of a EnclaveEndpointResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EnclaveEndpointResource items on this page", + "items": { + "$ref": "#/definitions/EnclaveEndpointResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EnclaveResource": { + "type": "object", + "description": "Virtual Enclave Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualEnclaveProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EnclaveResourceListResult": { + "type": "object", + "description": "The response of a EnclaveResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EnclaveResource items on this page", + "items": { + "$ref": "#/definitions/EnclaveResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EnclaveVirtualNetworkModel": { + "type": "object", + "description": "Enclave Virtual Network Properties", + "properties": { + "networkName": { + "type": "string", + "description": "Network Name." + }, + "networkSize": { + "type": "string", + "description": "Network Size.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "customCidrRange": { + "type": "string", + "description": "Custom CIDR Range.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "subnetConfigurations": { + "type": "array", + "description": "Subnet Configurations.", + "items": { + "$ref": "#/definitions/SubnetConfiguration" + }, + "x-ms-identifiers": [] + }, + "allowSubnetCommunication": { + "type": "boolean", + "description": "Allow Subnet Communication.", + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "FirewallSKU": { + "type": "string", + "description": "Azure Firewall SKU", + "enum": [ + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "FirewallSKU", + "modelAsString": true, + "values": [ + { + "name": "Basic", + "value": "Basic", + "description": "FirewallSKU Basic" + }, + { + "name": "Standard", + "value": "Standard", + "description": "FirwallSKU Standard" + }, + { + "name": "Premium", + "value": "Premium", + "description": "FirewallSKU Premium" + } + ] + } + }, + "GovernedServiceItem": { + "type": "object", + "description": "GovernedServiceItem Properties", + "properties": { + "serviceId": { + "$ref": "#/definitions/ServiceIdentifier", + "description": "Service ID" + }, + "serviceName": { + "type": "string", + "description": "Service name.", + "readOnly": true + }, + "option": { + "type": "string", + "description": "Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable).", + "enum": [ + "Allow", + "Deny", + "ExceptionOnly", + "NotApplicable" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "enforcement": { + "type": "string", + "description": "Initiative enforcement (Enabled or Disabled).", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "policyAction": { + "type": "string", + "description": "Enforcement mode for policy. AuditOnly, Enforce, or None.", + "enum": [ + "AuditOnly", + "Enforce", + "None" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "initiatives": { + "type": "array", + "description": "Initiatives associated with this service.", + "items": { + "type": "string" + }, + "readOnly": true + } + }, + "required": [ + "serviceId" + ] + }, + "KeyVaultResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + } + }, + "LogAnalyticsResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + } + }, + "MaintenanceModeConfigurationModel": { + "type": "object", + "description": "Maintenance Mode", + "properties": { + "mode": { + "type": "string", + "description": "Current mode of Maintenance Mode Configuration", + "default": "Off", + "enum": [ + "On", + "CanNotDelete", + "Off", + "General", + "Advanced" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "principals": { + "type": "array", + "description": "The user, group or service principal object affected by Maintenance Mode", + "default": [], + "items": { + "$ref": "#/definitions/Principal" + } + }, + "justification": { + "type": "string", + "description": "Justification for entering or exiting Maintenance Mode", + "default": "Off", + "enum": [ + "Networking", + "Governance", + "Off" + ], + "x-ms-enum": { + "modelAsString": true + } + } + }, + "required": [ + "mode" + ] + }, + "MaintenanceModeConfigurationPatchModel": { + "type": "object", + "description": "Maintenance Mode Patch Model", + "properties": { + "mode": { + "type": "string", + "description": "Current mode of Maintenance Mode Configuration", + "enum": [ + "On", + "CanNotDelete", + "Off", + "General", + "Advanced" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "principals": { + "type": "array", + "description": "The user, group or service principal object affected by Maintenance Mode", + "items": { + "$ref": "#/definitions/Principal" + } + }, + "justification": { + "type": "string", + "description": "Justification for entering or exiting Maintenance Mode", + "enum": [ + "Networking", + "Governance", + "Off" + ], + "x-ms-enum": { + "modelAsString": true + } + } + } + }, + "MandatoryApprover": { + "type": "object", + "description": "Approver Metadata for approvals request.", + "properties": { + "approverEntraId": { + "type": "string", + "description": "EntraId of the approver" + } + }, + "required": [ + "approverEntraId" + ] + }, + "NsgResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/networkSecurityGroups" + } + ] + } + }, + "Principal": { + "type": "object", + "description": "Principal for maintenance mode or role assignments", + "properties": { + "id": { + "type": "string", + "description": "The object id associated with the principal" + }, + "type": { + "type": "string", + "description": "The type of the object id. We currently allow users, groups, and service principals", + "enum": [ + "User", + "Group", + "ServicePrincipal" + ], + "x-ms-enum": { + "modelAsString": true + } + } + }, + "required": [ + "id", + "type" + ] + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning status of the resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Creating", + "Deleting", + "NotSpecified", + "Running", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Provisioning State Type Accepted" + }, + { + "name": "Creating", + "value": "Creating", + "description": "Provisioning State Type Creating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Provisioning State Type Deleting" + }, + { + "name": "NotSpecified", + "value": "NotSpecified", + "description": "Provisioning State Type NotSpecified" + }, + { + "name": "Running", + "value": "Running", + "description": "Provisioning State Type Running" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Provisioning State Type Updating" + } + ] + }, + "readOnly": true + }, + "RequestMetadata": { + "type": "object", + "description": "Request Metadata for approvals request.", + "properties": { + "resourceAction": { + "type": "string", + "description": "Resource Action of the item being approved or declined." + }, + "approvalCallbackRoute": { + "type": "string", + "description": "Route name for the approval callback" + }, + "approvalCallbackPayload": { + "type": "string", + "description": "Payload to be sent upon any action on approval request" + }, + "approvalStatus": { + "type": "string", + "description": "Status of the approval. Uses ApprovalStatus enum.", + "default": "Pending", + "enum": [ + "Approved", + "Rejected", + "Pending", + "Deleted", + "Expired" + ], + "x-ms-enum": { + "name": "ApprovalStatus", + "modelAsString": true, + "values": [ + { + "name": "Approved", + "value": "Approved", + "description": "ApprovalStatus Type Approved" + }, + { + "name": "Rejected", + "value": "Rejected", + "description": "ApprovalStatus Type Rejected" + }, + { + "name": "Pending", + "value": "Pending", + "description": "ApprovalStatus Type Pending" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "ApprovalStatus Type Deleted" + }, + { + "name": "Expired", + "value": "Expired", + "description": "ApprovalStatus Type Expired" + } + ] + } + } + }, + "required": [ + "resourceAction" + ] + }, + "RequestMetadataUpdatableProperties": { + "type": "object", + "description": "Request Metadata patch properties.", + "properties": { + "resourceAction": { + "type": "string", + "description": "Resource Action of the item being approved or declined." + }, + "approvalCallbackRoute": { + "type": "string", + "description": "Route name for the approval callback" + }, + "approvalCallbackPayload": { + "type": "string", + "description": "Payload to be sent upon any action on approval request" + }, + "approvalStatus": { + "$ref": "#/definitions/ApprovalStatus", + "description": "Status of the approval. Uses ApprovalStatus enum." + } + } + }, + "RoleAssignmentItem": { + "type": "object", + "description": "Role assignment item that indicates which principals should be assigned this role definition", + "properties": { + "roleDefinitionId": { + "type": "string", + "description": "Role definition identifier" + }, + "principals": { + "type": "array", + "description": "List of principal IDs to which to assign this role definition", + "items": { + "$ref": "#/definitions/Principal" + } + } + }, + "required": [ + "roleDefinitionId" + ] + }, + "ServiceIdentifier": { + "type": "string", + "description": "Identifier for governed services.", + "enum": [ + "AKS", + "AppService", + "AzureFirewalls", + "ContainerRegistry", + "CosmosDB", + "DataConnectors", + "Insights", + "KeyVault", + "Logic", + "MicrosoftSQL", + "Monitoring", + "PostgreSQL", + "PrivateDNSZones", + "ServiceBus", + "Storage" + ], + "x-ms-enum": { + "name": "ServiceIdentifier", + "modelAsString": true, + "values": [ + { + "name": "AKS", + "value": "AKS", + "description": "Service identifier for AKS" + }, + { + "name": "AppService", + "value": "AppService", + "description": "Service identifier for App Service" + }, + { + "name": "AzureFirewalls", + "value": "AzureFirewalls", + "description": "Service identifier for Azure Firewalls" + }, + { + "name": "ContainerRegistry", + "value": "ContainerRegistry", + "description": "Service identifier for Container Registry" + }, + { + "name": "CosmosDB", + "value": "CosmosDB", + "description": "Service identifier for CosmosDB" + }, + { + "name": "DataConnectors", + "value": "DataConnectors", + "description": "Service identifier for Data Connectors" + }, + { + "name": "Insights", + "value": "Insights", + "description": "Service identifier for Insights" + }, + { + "name": "KeyVault", + "value": "KeyVault", + "description": "Service identifier for Key Vault" + }, + { + "name": "Logic", + "value": "Logic", + "description": "Service identifier for Logic" + }, + { + "name": "MicrosoftSql", + "value": "MicrosoftSQL", + "description": "Service identifier for Microsoft SQL" + }, + { + "name": "Monitoring", + "value": "Monitoring", + "description": "Service identifier for Monitoring" + }, + { + "name": "PostgreSql", + "value": "PostgreSQL", + "description": "Service identifier for PostgreSQL" + }, + { + "name": "PrivateDNSZones", + "value": "PrivateDNSZones", + "description": "Service identifier for Private DNS Zones" + }, + { + "name": "ServiceBus", + "value": "ServiceBus", + "description": "Service identifier for Service Bus" + }, + { + "name": "Storage", + "value": "Storage", + "description": "Service identifier for Storage" + } + ] + } + }, + "StorageAccountResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + }, + "SubnetConfiguration": { + "type": "object", + "description": "Subnet Configuration", + "properties": { + "subnetName": { + "type": "string", + "description": "Subnet name." + }, + "subnetResourceId": { + "$ref": "#/definitions/SubnetResourceId", + "description": "Subnet Resource ID.", + "readOnly": true + }, + "networkPrefixSize": { + "type": "integer", + "format": "int32", + "description": "Network prefix size." + }, + "subnetDelegation": { + "type": "string", + "description": "Subnet delegation." + }, + "addressPrefix": { + "type": "string", + "description": "Address prefix.", + "readOnly": true + }, + "networkSecurityGroupResourceId": { + "$ref": "#/definitions/NsgResourceId", + "description": "Network security group ID.", + "readOnly": true + } + }, + "required": [ + "subnetName", + "networkPrefixSize" + ] + }, + "SubnetResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "TransitHubPatchModel": { + "type": "object", + "description": "TH Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/TransitHubPatchProperties", + "description": "The TransitHub resource." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TransitHubPatchProperties": { + "type": "object", + "description": "Transit Hub patchable Properties", + "properties": { + "state": { + "$ref": "#/definitions/TransitHubState", + "description": "The state of the transitHub." + }, + "transitOption": { + "$ref": "#/definitions/TransitOption", + "description": "The TransitOption of the transitHub." + } + } + }, + "TransitHubProperties": { + "type": "object", + "description": "Describes the properties of an Transit Hub.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/TransitHubState", + "description": "The state of the transitHub." + }, + "transitOption": { + "$ref": "#/definitions/TransitOption", + "description": "The TransitOption of the transitHub." + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids modified by transitHubs.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource." + }, + "readOnly": true + } + } + }, + "TransitHubResource": { + "type": "object", + "description": "TransitHub Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/TransitHubProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "TransitHubResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Mission/communities/transitHubs" + } + ] + } + }, + "TransitHubResourceListResult": { + "type": "object", + "description": "The response of a TransitHubResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The TransitHubResource items on this page", + "items": { + "$ref": "#/definitions/TransitHubResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "TransitHubState": { + "type": "string", + "description": "Specifies the state of the transitHub.", + "enum": [ + "PendingApproval", + "Approved", + "PendingUpdate", + "Active", + "Failed" + ], + "x-ms-enum": { + "name": "TransitHubState", + "modelAsString": true, + "values": [ + { + "name": "PendingApproval", + "value": "PendingApproval", + "description": "TransitHubState Type PendingApproval" + }, + { + "name": "Approved", + "value": "Approved", + "description": "TransitHubState Type Approved" + }, + { + "name": "PendingUpdate", + "value": "PendingUpdate", + "description": "TransitHubState Type PendingUpdate" + }, + { + "name": "Active", + "value": "Active", + "description": "TransitHubState Type Active" + }, + { + "name": "Failed", + "value": "Failed", + "description": "TransitHubState Type Failed" + } + ] + } + }, + "TransitOption": { + "type": "object", + "description": "TransitOption Properties", + "properties": { + "type": { + "$ref": "#/definitions/TransitOptionType", + "description": "Transit Option Type." + }, + "params": { + "$ref": "#/definitions/TransitOptionParams", + "description": "Transit Option Params" + } + } + }, + "TransitOptionParams": { + "type": "object", + "description": "TransitOptionParams Properties", + "properties": { + "scaleUnits": { + "type": "integer", + "format": "int64", + "description": "Transit Option Params scaleUnits." + }, + "remoteVirtualNetworkId": { + "$ref": "#/definitions/VirtualNetworkResourceId", + "description": "Transit Option Params remoteVirtualNetworkId." + } + } + }, + "TransitOptionType": { + "type": "string", + "description": "Specifies the type of the transitOption.", + "enum": [ + "ExpressRoute", + "Gateway", + "Peering" + ], + "x-ms-enum": { + "name": "TransitOptionType", + "modelAsString": true, + "values": [ + { + "name": "ExpressRoute", + "value": "ExpressRoute", + "description": "TransitOptionType ExpressRoute" + }, + { + "name": "Gateway", + "value": "Gateway", + "description": "TransitOptionType Gateway" + }, + { + "name": "Peering", + "value": "Peering", + "description": "TransitOptionType Peering" + } + ] + } + }, + "VirtualEnclavePatchModel": { + "type": "object", + "description": "Virtual Enclave Patch Model", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualEnclavePatchProperties", + "description": "Virtual Enclave Patch properties" + }, + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.ManagedServiceIdentityUpdate", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualEnclavePatchProperties": { + "type": "object", + "description": "Virtual Enclave Patchable Properties", + "properties": { + "enclaveVirtualNetwork": { + "$ref": "#/definitions/EnclaveVirtualNetworkModel", + "description": "Virtual Network." + }, + "bastionEnabled": { + "type": "boolean", + "description": "Deploy Bastion service (True or False)." + }, + "enclaveRoleAssignments": { + "type": "array", + "description": "Enclave role assignments", + "items": { + "$ref": "#/definitions/RoleAssignmentItem" + }, + "x-ms-identifiers": [] + }, + "workloadRoleAssignments": { + "type": "array", + "description": "Workload role assignments", + "items": { + "$ref": "#/definitions/RoleAssignmentItem" + }, + "x-ms-identifiers": [] + }, + "governedServiceList": { + "type": "array", + "description": "Enclave specific policies", + "items": { + "$ref": "#/definitions/GovernedServiceItem" + }, + "x-ms-identifiers": [] + }, + "enclaveDefaultSettings": { + "$ref": "#/definitions/EnclaveDefaultSettingsPatchModel", + "description": "Enclave default settings." + }, + "maintenanceModeConfiguration": { + "$ref": "#/definitions/MaintenanceModeConfigurationPatchModel", + "description": "Maintenance Mode configuration." + } + } + }, + "VirtualEnclaveProperties": { + "type": "object", + "description": "Virtual Enclave Resource properties", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + }, + "enclaveVirtualNetwork": { + "$ref": "#/definitions/EnclaveVirtualNetworkModel", + "description": "Virtual Network." + }, + "enclaveAddressSpaces": { + "$ref": "#/definitions/EnclaveAddressSpacesModel", + "description": "Enclave Address Spaces", + "readOnly": true + }, + "communityResourceId": { + "$ref": "#/definitions/CommunityResourceId", + "description": "Community Resource Id.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "resourceCollection": { + "type": "array", + "description": "List of resource ids created by Virtual Enclave.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource." + }, + "readOnly": true + }, + "managedResourceGroupName": { + "type": "string", + "description": "Managed resource group name.", + "readOnly": true + }, + "managedOnBehalfOfConfiguration": { + "$ref": "../../../../../common-types/resource-management/v5/mobo.json#/definitions/ManagedOnBehalfOfConfiguration", + "description": "Managed On Behalf Of Configuration.", + "readOnly": true + }, + "bastionEnabled": { + "type": "boolean", + "description": "Deploy Bastion service (True or False).", + "default": false + }, + "enclaveRoleAssignments": { + "type": "array", + "description": "Enclave role assignments", + "items": { + "$ref": "#/definitions/RoleAssignmentItem" + }, + "x-ms-identifiers": [] + }, + "workloadRoleAssignments": { + "type": "array", + "description": "Workload role assignments", + "items": { + "$ref": "#/definitions/RoleAssignmentItem" + }, + "x-ms-identifiers": [] + }, + "governedServiceList": { + "type": "array", + "description": "Enclave specific policies", + "items": { + "$ref": "#/definitions/GovernedServiceItem" + }, + "x-ms-identifiers": [] + }, + "enclaveDefaultSettings": { + "$ref": "#/definitions/EnclaveDefaultSettingsModel", + "description": "Enclave default settings." + }, + "maintenanceModeConfiguration": { + "$ref": "#/definitions/MaintenanceModeConfigurationModel", + "description": "Maintenance Mode configuration." + } + }, + "required": [ + "enclaveVirtualNetwork", + "communityResourceId" + ] + }, + "VirtualNetworkResourceId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks" + } + ] + } + }, + "WorkloadPatchModel": { + "type": "object", + "description": "Workload Patch Resource", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadPatchProperties", + "description": "Workload Patch properties" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "WorkloadPatchProperties": { + "type": "object", + "description": "Workload patchable Properties", + "properties": { + "resourceGroupCollection": { + "type": "array", + "description": "List of resource group ids.", + "items": { + "type": "string" + } + } + } + }, + "WorkloadProperties": { + "type": "object", + "description": "Workload Resource properties", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State.", + "readOnly": true + }, + "resourceGroupCollection": { + "type": "array", + "description": "List of resource group ids.", + "items": { + "type": "string" + } + }, + "managedOnBehalfOfConfiguration": { + "$ref": "../../../../../common-types/resource-management/v5/mobo.json#/definitions/ManagedOnBehalfOfConfiguration", + "description": "Managed On Behalf Of Configuration.", + "readOnly": true + } + } + }, + "WorkloadResource": { + "type": "object", + "description": "Workload Model Resource", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "WorkloadResourceListResult": { + "type": "object", + "description": "The response of a WorkloadResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadResource items on this page", + "items": { + "$ref": "#/definitions/WorkloadResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + } + }, + "parameters": { + "Azure.ResourceManager.ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "description": "The fully qualified Azure Resource manager identifier of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/mission/resource-manager/readme.az.md b/specification/mission/resource-manager/readme.az.md new file mode 100644 index 000000000000..55ce2d907c35 --- /dev/null +++ b/specification/mission/resource-manager/readme.az.md @@ -0,0 +1,28 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +For new Resource Provider. It is highly recommended to onboard Azure CLI extensions. There's no differences in terms of customer usage. + +``` yaml $(az) && $(target-mode) != 'core' +az: + extensions: mission + namespace: azure.mgmt.mission + package-name: azure-mgmt-mission +az-output-folder: $(azure-cli-extension-folder)/src/mission +python-sdk-output-folder: "$(az-output-folder)/azext_mission/vendored_sdks/mission" +# add additional configuration here specific for Azure CLI +# refer to the faq.md for more details +``` + + + +This is for command modules that already in azure cli main repo. +``` yaml $(az) && $(target-mode) == 'core' +az: + extensions: mission + namespace: azure.mgmt.mission + package-name: azure-mgmt-mission +az-output-folder: $(azure-cli-folder)/src/azure-cli/azure/cli/command_modules/mission +python-sdk-output-folder: "$(az-output-folder)/vendored_sdks/mission" +``` \ No newline at end of file diff --git a/specification/mission/resource-manager/readme.cli.md b/specification/mission/resource-manager/readme.cli.md new file mode 100644 index 000000000000..c6cf6ad37ea4 --- /dev/null +++ b/specification/mission/resource-manager/readme.cli.md @@ -0,0 +1 @@ +## CLI Common Settings for all the command line tools \ No newline at end of file diff --git a/specification/mission/resource-manager/readme.csharp.md b/specification/mission/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..f8860f65378e --- /dev/null +++ b/specification/mission/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.Mission + output-folder: $(csharp-sdks-folder)/mission/management/Microsoft.Mission/GeneratedProtocol +``` diff --git a/specification/mission/resource-manager/readme.go.md b/specification/mission/resource-manager/readme.go.md new file mode 100644 index 000000000000..33c3f3ca4132 --- /dev/null +++ b/specification/mission/resource-manager/readme.go.md @@ -0,0 +1,11 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/mission/armmission +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +``` diff --git a/specification/mission/resource-manager/readme.md b/specification/mission/resource-manager/readme.md new file mode 100644 index 000000000000..4e1b0d08c839 --- /dev/null +++ b/specification/mission/resource-manager/readme.md @@ -0,0 +1,96 @@ +# mission + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for mission. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +These are the global settings for the mission. + +```yaml +title: missionClient +openapi-type: arm +openapi-subtype: rpaas +tag: package-2025-05-01-preview +``` + +### Tag: package-2025-05-01-preview + +These settings apply only when `--tag=package-2025-05-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2025-05-01-preview' +input-file: + - Microsoft.Mission/preview/2025-05-01-preview/openapi.json +``` + +### Tag: package-2024-12-01-preview + +These settings apply only when `--tag=package-2024-12-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-12-01-preview' +input-file: + - Microsoft.Mission/preview/2024-12-01-preview/openapi.json +``` + +### Tag: package-2024-06-01-preview + +These settings apply only when `--tag=package-2024-06-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-06-01-preview' +input-file: + - Microsoft.Mission/preview/2024-06-01-preview/openapi.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go-track2 + - repo: azure-sdk-for-js + - repo: azure-resource-manager-schemas + - repo: azure-cli-extensions +``` + +## Az + +See configuration in [readme.az.md](./readme.az.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/mission/resource-manager/readme.python.md b/specification/mission/resource-manager/readme.python.md new file mode 100644 index 000000000000..d838cd3fdcff --- /dev/null +++ b/specification/mission/resource-manager/readme.python.md @@ -0,0 +1,18 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-mission +namespace: azure.mgmt.mission +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/mission/azure-mgmt-mission/azure/mgmt/mission +``` diff --git a/specification/mission/resource-manager/readme.typescript.md b/specification/mission/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..d12b48fd3cdf --- /dev/null +++ b/specification/mission/resource-manager/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-mission" + output-folder: "$(typescript-sdks-folder)/sdk/mission/arm-mission" + payload-flattening-threshold: 1 + clear-output-folder: true + generate-metadata: true +``` diff --git a/specification/monitor/Monitor.Query.Metrics/client.tsp b/specification/monitor/Monitor.Query.Metrics/client.tsp index 612b9c8e6c86..eb7e37a92fcf 100644 --- a/specification/monitor/Monitor.Query.Metrics/client.tsp +++ b/specification/monitor/Monitor.Query.Metrics/client.tsp @@ -28,3 +28,6 @@ using MonitorQueryMetrics; ); @@clientName(Metric.timeseries, "TimeSeries", "go"); + +@@clientName(MonitorQueryMetrics, "MetricsClient", "python"); +@@access(batch, Access.internal, "python"); diff --git a/specification/monitor/Monitor.Query.Metrics/tspconfig.yaml b/specification/monitor/Monitor.Query.Metrics/tspconfig.yaml index 7ee720c63c1d..a9fbe43b64c6 100644 --- a/specification/monitor/Monitor.Query.Metrics/tspconfig.yaml +++ b/specification/monitor/Monitor.Query.Metrics/tspconfig.yaml @@ -20,8 +20,9 @@ options: package-dir: "azure-monitor-querymetrics" package-name: "{package-dir}" package-mode: dataplane + package-version: 1.0.0 flavor: azure - namespace: azure.monitor.querymetrics._generated + namespace: azure.monitor.querymetrics "@azure-tools/typespec-csharp": package-dir: "Azure.Monitor.Query.Metrics" namespace: "{package-dir}"