diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 00e98dad13e1..3646d292b975 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -65,7 +65,7 @@ /specification/cognitiveservices/data-plane/Language/ @assafi @rokulka @ChongTang @annatisch @heaths @deyaaeldeen @kristapratico @mssfang @joseharriaga @minhanh-phan # PRLabel: %Compute -/specification/compute/ @bilaakpan-ms @sandido @dkulkarni-ms @haagha @MS-syh2qs @grizzlytheodore @mabhard @danielli90 @smotwani @ppatwa @vikramd-ms @yunusm @ZhidongPeng @nkuchta @maheshnemichand @najams @changov +/specification/compute/ @xinzewang233 @audreyttt @haagha @bilaakpan-ms @grizzlytheodore @mabhard @danielli90 @smotwani @ppatwa @vikramd-ms @yunusm @ZhidongPeng @nkuchta @maheshnemichand @najams @changov /specification/consumption/ @arusing @micahbresette diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 7c584b8e0a10..ab136f1142d9 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1,3 +1,38 @@ +# New TypeSpec projects + +Before creating or initializing a TypeSpec project, you must know your org name, service name, and the type of service: data-plane or control-plane (ARM). + +Then create a new project directory under the `specification//resource-manager//` or `specification//data-plane/` path, following the guidelines below. + +``` +specification/ +└── / + ├── cspell.yaml + └── resource-manager/ + ├── readme.md ß NOTE: For ARM schema validation; see bullet #2 below + └── / ß NOTE: Control-plane only (not data-plane) + └── / ß Customer-facing service name; each version gets Documentation & SDK package + ├── tspconfig.yaml ß TypeSpec files + ├── main.tsp + ├── models.tsp + ├── readme.md ß autorest readme with YAML blocks + └── examples/ ß TypeSpec example folder + └── / ß One folder per service version described in TypeSpec + └── + └── preview/ and stable/ + └── / ß One folder per service version described in OpenAPI. These folders are created and populated by compiling the TypeSpec folder for the service. + ├── + └── examples/ ß OpenAPI example folder + └── + └── / // Customer-facing service name; contents identical to above structure + └── data-plane/ + └── / // Customer-facing service name; contents identical to above structure +``` + +Use the `./specification/widget` directory as a reference for creating your own project directory. + +Only after the project directory is created according to the above guidelines may you run the `azsdk_init_typespec_project` tool to initialize the project. + ## Converting a specification from swagger to typespec Users can convert a specification from swagger to typespec by using `tsp-client` a CLI designed to help developers throughout various stages of typespec development. @@ -130,6 +165,10 @@ enum Versions { - camelCase fixes only apply to the typespec property names, any corresponding string values you should left as is. - String values in typespec files should be left untouched. +## Up-to-date TypeSpec documentation + +Follow [typespec docs](../eng/common/instructions/azsdk-tools/typespec-docs.instructions.md) to get the most up-to-date documentation for TypeSpec, including best practices for writing TypeSpec for Azure. + [contoso-widget-manager]: ../specification/contosowidgetmanager/Contoso.WidgetManager/ @@ -140,67 +179,68 @@ enum Versions { [ci-fix]: ../documentation/ci-fix.md [url-type]: https://typespec.io/docs/language-basics/built-in-types#string-types [no-enum]: https://azure.github.io/typespec-azure/docs/libraries/azure-core/rules/no-enum - +[typespec-structure-guidelines]: ../documentation/typespec-structure-guidelines.md # SDK generation from TypeSpec -## Agent context for TypeSpec and SDK process -- Check all open files in the editor and check if `main.tsp` or `tspconfig.yaml` are open in the editor. If either of -these files are open, then use the parent path of the `main.tsp` or `tspconfig.yaml` as default TypeSpec project root -path. -- If `main.tsp` and `tspconfig.yaml` are not open in the editor, then check if there are any TypeSpec project paths in -the context. If there are no TypeSpec project paths in the context, then prompt user to select a TypeSpec project path -from the list of paths. If user does not have a TypeSpec project, then prompt user to create a new TypeSpec project. +## Agent context for TypeSpec and SDK process +- Check all open files in the editor and check if `main.tsp` or `tspconfig.yaml` are open in the editor. If either of + these files are open, then use the parent path of the `main.tsp` or `tspconfig.yaml` as default TypeSpec project root + path. +- If `main.tsp` and `tspconfig.yaml` are not open in the editor, then check if there are any TypeSpec project paths in + the context. If there are no TypeSpec project paths in the context, then prompt user to select a TypeSpec project path + from the list of paths. If user does not have a TypeSpec project, then prompt user to create a new TypeSpec project. ### Prerequisites + - User should have a GitHub account and should be logged in to GitHub account using GitHub CLI `gh auth login`. - run `npm ci` to install the dependencies - To use Azure MCP tool calls, the user must have PowerShell installed. Provide [PowerShell installation instructions](https://learn.microsoft.com/powershell/scripting/install/installing-powershell) if not installed, and recommend restarting the IDE to start the MCP server. - ### Basic Rules for SDK Generation from TypeSpec 1. **User Guidance**: - - Assume the user is unfamiliar with the SDK release process. Provide clear, concise instructions for each step. + - Assume the user is unfamiliar with the SDK release process. Provide clear, concise instructions for each step. 2. **File Handling**: - - Do not overwrite `tspconfig.yaml` or `main.tsp`. Use existing files and suggest updates if necessary. - - Use the path of the `tspconfig.yaml` file already open in the editor or the `.tsp` file path as the project root. - - If no `.tsp` file or folder is in the current context, prompt the user to select a valid TypeSpec project root path. + - Do not overwrite `tspconfig.yaml` or `main.tsp`. Use existing files and suggest updates if necessary. + - Use the path of the `tspconfig.yaml` file already open in the editor or the `.tsp` file path as the project root. + - If no `.tsp` file or folder is in the current context, prompt the user to select a valid TypeSpec project root path. 3. **Process Visibility**: - - Highlight all steps in the SDK generation process, showing completed and remaining steps. - - Do not skip any main steps. Ensure all steps are completed before moving to the next. + - Highlight all steps in the SDK generation process, showing completed and remaining steps. + - Do not skip any main steps. Ensure all steps are completed before moving to the next. 4. **Git Operations**: - - Avoid using the `main` branch for pull requests. Prompt the user to create or switch to a new branch if necessary. - - Display git commands (e.g., `git checkout`, `git add`, `git commit`, `git push`) with a "Run" button instead of - asking the user to copy and paste. - - Do not run `git diff` + - Avoid using the `main` branch for pull requests. Prompt the user to create or switch to a new branch if necessary. + - Display git commands (e.g., `git checkout`, `git add`, `git commit`, `git push`) with a "Run" button instead of + asking the user to copy and paste. + - Do not run `git diff` 5. **Azure-Specific Rules**: - - Always use `Azure` as the repo owner in MCP tool calls. - - Confirm with the user if they want to change the repo owner or target branch, and prompt for new values if needed. + - Always use `Azure` as the repo owner in MCP tool calls. + - Confirm with the user if they want to change the repo owner or target branch, and prompt for new values if needed. 6. **Exclusions**: - - Exclude changes to the `.gitignore` file and contents within the `.github` and `.vscode` folders from API spec and SDK pull requests. + - Exclude changes to the `.gitignore` file and contents within the `.github` and `.vscode` folders from API spec and SDK pull requests. 7. **Working Branch Rule**: - - If the typespec pull request already exists or is merged stay on the `main` branch, otherwise ensure the TypeSpec project repository and the current working repository are not on the `main` branch: - - Check the current branch name for the cloned GitHub repository: - - If the current branch is `main`, prompt the user to create a new branch using - `git checkout -b `. - - If the current branch is not `main`, prompt the user to either select an existing branch or create a - new one. - - For branch switching: - - If a branch already exists and differs from the current branch, prompt the user to switch using - `git checkout `. - - GitHub pull requests cannot be created from the `main` branch. Ensure all changes are made on a non-`main` branch. + - If the typespec pull request already exists or is merged stay on the `main` branch, otherwise ensure the TypeSpec project repository and the current working repository are not on the `main` branch: + - Check the current branch name for the cloned GitHub repository: + - If the current branch is `main`, prompt the user to create a new branch using + `git checkout -b `. + - If the current branch is not `main`, prompt the user to either select an existing branch or create a + new one. + - For branch switching: + - If a branch already exists and differs from the current branch, prompt the user to switch using + `git checkout `. + - GitHub pull requests cannot be created from the `main` branch. Ensure all changes are made on a non-`main` branch. By following these rules, the SDK release process will remain clear, structured, and user-friendly. ## Steps to generate SDK from TypeSpec API specification + Follow [typespec to sdk](..\eng\common\instructions\azsdk-tools\typespec-to-sdk.instructions.md) to generate and release SDK from TypeSpec API specification. The process is divided into several steps, each with specific actions to ensure a smooth SDK generation and release process. Do not skip the step that choose SDK generation method to ensure the user selects the appropriate method for SDK generation, either locally or using the SDK generation pipeline. Do not repeat the steps. Before using tools, check if user has Powershell installed. @@ -210,7 +250,7 @@ Do not skip the step that choose SDK generation method to ensure the user select 4. **Review and Commit Changes**: Stage and commit TypeSpec modifications, ensuring the current branch is not "main". Do not create pull request yet. 5. **Create Specification Pull Request**: Create a pull request for TypeSpec changes if not already created. This is required only if there are TypeSpec changes in current branch. 6. **Choose SDK Generation Method**: Determine how to generate SDKs (locally or via pipeline). Only Python is supported for local SDK generation at this time. -7. **Generate SDKs via Pipeline**: Generate SDKs using [run sdk gen pipeline](..\eng\common\instructions\azsdk-tools\run-sdk-gen-pipeline.instructions.md), monitor the pipeline status and displaying generated SDK PR links. +7. **Generate SDKs via Pipeline**: Generate SDKs using [run sdk gen pipeline](..\eng\common\instructions\azsdk-tools\run-sdk-gen-pipeline.instructions.md), monitor the pipeline status and displaying generated SDK PR links. 8. **Show generated SDK PR**: Display the generated SDK pull request links for review. 9. **Validate Label and then Codeowners**: Validate the service label and codeowners for the created SDK service using both [validate service label](..\eng\common\instructions\azsdk-tools\validate-service-label.instructions.md) and [validate codeowners](..\eng\common\instructions\azsdk-tools\validate-codeowners.instructions.md). 10. **Create a release plan**: To create a release plan refer to [create release plan](..\eng\common\instructions\azsdk-tools\create-release-plan.instructions.md) @@ -218,12 +258,14 @@ Do not skip the step that choose SDK generation method to ensure the user select 12. **Release package**: Release the SDK package using `azsdk_release_sdk` tool. ## Release readiness of SDK and information about the release pipeline + Run [check package readiness](..\eng\common\instructions\azsdk-tools\check-package-readiness.instructions.md) to check the release readiness of an SDK package. This prompt will collect the required information from the user, execute the readiness check, and present the results. ## Instructions for GitHub coding agent to generate SDKs using GitHub.com + Run only SDK generation step and Update SDK details back in issue description and release plan. Do not run TypeSpec validation, or service label check. This is applicable only when GitHub copilot coding agent is used to generate SDK and if a Release Plan is available in the context. Coding agent must wait until all SDK generation pipeline are in completed status and then fetch the SDK details from pipeline run. This is applicable only when a GitHub issue is assigned to GitHub coding agent to generate SDK from a TypeSpec project. This is not applicable when running Copilot from Visual Studio and VS Code. - + steps: - Run SDK generation pipeline for the given TypeSpec path for all languages mentioned in the description. - Keep checking the pipeline status until pipeline is in completed or failed status. @@ -231,4 +273,4 @@ Coding agent must wait until all SDK generation pipeline are in completed status constraints: - Do not invoke other steps. - Do not modify main.tsp file or any files in TypeSpec project. - - Do not add API version to an existing main.tsp if input API version is not present. + - Do not add API version to an existing main.tsp if input API version is not present. \ No newline at end of file diff --git a/.github/instructions/openapi-review.instructions.md b/.github/instructions/openapi-review.instructions.md index b96bd1d9462c..36c3bf751ae2 100644 --- a/.github/instructions/openapi-review.instructions.md +++ b/.github/instructions/openapi-review.instructions.md @@ -4,7 +4,7 @@ applyTo: "**/*.json" # Copilot Review Instructions for reviewing OpenAPI v2 -Please review OpenAPI v2 (Swagger) definition files with the following in mind: +When performing a code review, review OpenAPI v2 (Swagger) definition files with the following in mind: ## API Guidelines Alignment diff --git a/.github/package-lock.json b/.github/package-lock.json index 43f7958b9853..815c989dbd38 100644 --- a/.github/package-lock.json +++ b/.github/package-lock.json @@ -4,22 +4,21 @@ "requires": true, "packages": { "": { - "name": ".github", "dependencies": { - "@apidevtools/json-schema-ref-parser": "^14.1.1", - "debug": "^4.4.0", + "@apidevtools/json-schema-ref-parser": "^14.2.1", + "debug": "^4.4.3", "js-yaml": "^4.1.0", "markdown-table": "^3.0.4", - "marked": "^16.1.1", + "marked": "^16.3.0", "simple-git": "^3.27.0", - "zod": "^4.0.2" + "zod": "^4.1.8" }, "devDependencies": { "@actions/github-script": "github:actions/github-script", "@eslint/js": "^9.22.0", "@octokit/endpoint": "^11.0.0", "@octokit/rest": "^22.0.0", - "@octokit/types": "^14.1.0", + "@octokit/types": "^15.0.0", "@octokit/webhooks-types": "^7.5.1", "@tsconfig/node20": "^20.1.4", "@types/debug": "^4.1.12", @@ -77,7 +76,8 @@ }, "node_modules/@actions/github-script": { "version": "7.0.1", - "resolved": "git+ssh://git@github.com/actions/github-script.git#f28e40c7f34bde8b3046d885e986cb6290c5673b", + "resolved": "git+ssh://git@github.com/actions/github-script.git#ed597411d8f924073f98dfc5c65a23a2325f34cd", + "integrity": "sha512-QlJdlanFeTmYRG/IT5xe4rtdc9xi5weDPhP3xUylBUWyOY25/NZP/zRbJ5ET8ZyhVu6wulAJ0CwEn0YswVfzug==", "dev": true, "license": "MIT", "dependencies": { @@ -89,12 +89,29 @@ "@octokit/core": "^5.0.1", "@octokit/plugin-request-log": "^4.0.0", "@octokit/plugin-retry": "^6.0.1", - "@types/node": "^20.9.0" + "@types/node": "^24.1.0" }, "engines": { - "node": ">=20.0.0 <21.0.0" + "node": ">=24" } }, + "node_modules/@actions/github-script/node_modules/@types/node": { + "version": "24.5.0", + "resolved": "https://registry.npmjs.org/@types/node/-/node-24.5.0.tgz", + "integrity": "sha512-y1dMvuvJspJiPSDZUQ+WMBvF7dpnEqN4x9DDC9ie5Fs/HUZJA3wFp7EhHoVaKX/iI0cRoECV8X2jL8zi0xrHCg==", + "dev": true, + "license": "MIT", + "dependencies": { + "undici-types": "~7.12.0" + } + }, + "node_modules/@actions/github-script/node_modules/undici-types": { + "version": "7.12.0", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.12.0.tgz", + "integrity": "sha512-goOacqME2GYyOZZfb5Lgtu+1IDmAlAEu5xnD3+xTzS10hT0vzpf0SPjkXwAw9Jm+4n/mQGDP3LO8CPbYROeBfQ==", + "dev": true, + "license": "MIT" + }, "node_modules/@actions/glob": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/@actions/glob/-/glob-0.4.0.tgz", @@ -139,9 +156,9 @@ } }, "node_modules/@apidevtools/json-schema-ref-parser": { - "version": "14.2.0", - "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-14.2.0.tgz", - "integrity": "sha512-NaGMMWwppbByagq+LwQMq6PMXHFWVu6kSwwx+eJfYTJ5zdpOvb9TIk6ZWxEEeXMUvGdVOZq3JalYsjsTZDvtkA==", + "version": "14.2.1", + "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-14.2.1.tgz", + "integrity": "sha512-HmdFw9CDYqM6B25pqGBpNeLCKvGPlIx1EbLrVL0zPvj50CJQUHyBNBw45Muk0kEIkogo1VZvOKHajdMuAzSxRg==", "license": "MIT", "dependencies": { "js-yaml": "^4.1.0" @@ -659,9 +676,9 @@ } }, "node_modules/@eslint-community/eslint-utils": { - "version": "4.7.0", - "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.7.0.tgz", - "integrity": "sha512-dyybb3AcajC7uha6CvhdVRJqaKyn7w2YKqKyAN37NKYgZT36w+iRb0Dymmc5qEJ549c/S31cMMSFd75bteCpCw==", + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.9.0.tgz", + "integrity": "sha512-ayVFHdtZ+hsq1t2Dy24wCmGXGe4q9Gu3smhLYALJrr473ZH27MsnSL+LKUlimp4BWJqMDMLmPpx/Q9R3OAlL4g==", "dev": true, "license": "MIT", "dependencies": { @@ -776,9 +793,9 @@ } }, "node_modules/@eslint/js": { - "version": "9.34.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.34.0.tgz", - "integrity": "sha512-EoyvqQnBNsV1CWaEJ559rxXL4c8V92gxirbawSmVUOWXlsRxxQXl6LmCpdUblgxgSkDIqKnhzba2SjRTI/A5Rw==", + "version": "9.35.0", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.35.0.tgz", + "integrity": "sha512-30iXE9whjlILfWobBkNerJo+TXYsgVM5ERQwMcMKCHckHflCmf7wXDAHlARoWnh0s1U72WqlbeyE7iAcCzuCPw==", "dev": true, "license": "MIT", "engines": { @@ -1068,6 +1085,23 @@ "node": ">= 20" } }, + "node_modules/@octokit/endpoint/node_modules/@octokit/openapi-types": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-25.1.0.tgz", + "integrity": "sha512-idsIggNXUKkk0+BExUn1dQ92sfysJrje03Q0bv0e+KPLrvyqZF8MnBpFz8UNfYDwB3Ie7Z0TByjWfzxt7vseaA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@octokit/endpoint/node_modules/@octokit/types": { + "version": "14.1.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-14.1.0.tgz", + "integrity": "sha512-1y6DgTy8Jomcpu33N+p5w58l6xyt55Ar2I91RPiIA0xCJBXyUAhXCcmZaDWSANiha7R9a6qJJ2CRomGPZ6f46g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@octokit/openapi-types": "^25.1.0" + } + }, "node_modules/@octokit/endpoint/node_modules/universal-user-agent": { "version": "7.0.3", "resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-7.0.3.tgz", @@ -1108,9 +1142,9 @@ } }, "node_modules/@octokit/openapi-types": { - "version": "25.1.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-25.1.0.tgz", - "integrity": "sha512-idsIggNXUKkk0+BExUn1dQ92sfysJrje03Q0bv0e+KPLrvyqZF8MnBpFz8UNfYDwB3Ie7Z0TByjWfzxt7vseaA==", + "version": "26.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-26.0.0.tgz", + "integrity": "sha512-7AtcfKtpo77j7Ts73b4OWhOZHTKo/gGY8bB3bNBQz4H+GRSWqx2yvj8TXRsbdTE0eRmYmXOEY66jM7mJ7LzfsA==", "dev": true, "license": "MIT" }, @@ -1367,6 +1401,13 @@ "node": ">= 20" } }, + "node_modules/@octokit/rest/node_modules/@octokit/openapi-types": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-25.1.0.tgz", + "integrity": "sha512-idsIggNXUKkk0+BExUn1dQ92sfysJrje03Q0bv0e+KPLrvyqZF8MnBpFz8UNfYDwB3Ie7Z0TByjWfzxt7vseaA==", + "dev": true, + "license": "MIT" + }, "node_modules/@octokit/rest/node_modules/@octokit/plugin-paginate-rest": { "version": "13.1.1", "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-13.1.1.tgz", @@ -1442,6 +1483,16 @@ "node": ">= 20" } }, + "node_modules/@octokit/rest/node_modules/@octokit/types": { + "version": "14.1.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-14.1.0.tgz", + "integrity": "sha512-1y6DgTy8Jomcpu33N+p5w58l6xyt55Ar2I91RPiIA0xCJBXyUAhXCcmZaDWSANiha7R9a6qJJ2CRomGPZ6f46g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@octokit/openapi-types": "^25.1.0" + } + }, "node_modules/@octokit/rest/node_modules/before-after-hook": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-4.0.0.tgz", @@ -1457,13 +1508,13 @@ "license": "ISC" }, "node_modules/@octokit/types": { - "version": "14.1.0", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-14.1.0.tgz", - "integrity": "sha512-1y6DgTy8Jomcpu33N+p5w58l6xyt55Ar2I91RPiIA0xCJBXyUAhXCcmZaDWSANiha7R9a6qJJ2CRomGPZ6f46g==", + "version": "15.0.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-15.0.0.tgz", + "integrity": "sha512-8o6yDfmoGJUIeR9OfYU0/TUJTnMPG2r68+1yEdUeG2Fdqpj8Qetg0ziKIgcBm0RW/j29H41WP37CYCEhp6GoHQ==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/openapi-types": "^25.1.0" + "@octokit/openapi-types": "^26.0.0" } }, "node_modules/@octokit/webhooks-types": { @@ -1836,17 +1887,17 @@ } }, "node_modules/@typescript-eslint/eslint-plugin": { - "version": "8.41.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.41.0.tgz", - "integrity": "sha512-8fz6oa6wEKZrhXWro/S3n2eRJqlRcIa6SlDh59FXJ5Wp5XRZ8B9ixpJDcjadHq47hMx0u+HW6SNa6LjJQ6NLtw==", + "version": "8.44.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.44.0.tgz", + "integrity": "sha512-EGDAOGX+uwwekcS0iyxVDmRV9HX6FLSM5kzrAToLTsr9OWCIKG/y3lQheCq18yZ5Xh78rRKJiEpP0ZaCs4ryOQ==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/regexpp": "^4.10.0", - "@typescript-eslint/scope-manager": "8.41.0", - "@typescript-eslint/type-utils": "8.41.0", - "@typescript-eslint/utils": "8.41.0", - "@typescript-eslint/visitor-keys": "8.41.0", + "@typescript-eslint/scope-manager": "8.44.0", + "@typescript-eslint/type-utils": "8.44.0", + "@typescript-eslint/utils": "8.44.0", + "@typescript-eslint/visitor-keys": "8.44.0", "graphemer": "^1.4.0", "ignore": "^7.0.0", "natural-compare": "^1.4.0", @@ -1860,7 +1911,7 @@ "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "@typescript-eslint/parser": "^8.41.0", + "@typescript-eslint/parser": "^8.44.0", "eslint": "^8.57.0 || ^9.0.0", "typescript": ">=4.8.4 <6.0.0" } @@ -1876,16 +1927,16 @@ } }, "node_modules/@typescript-eslint/parser": { - "version": "8.41.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.41.0.tgz", - "integrity": "sha512-gTtSdWX9xiMPA/7MV9STjJOOYtWwIJIYxkQxnSV1U3xcE+mnJSH3f6zI0RYP+ew66WSlZ5ed+h0VCxsvdC1jJg==", + "version": "8.44.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.44.0.tgz", + "integrity": "sha512-VGMpFQGUQWYT9LfnPcX8ouFojyrZ/2w3K5BucvxL/spdNehccKhB4jUyB1yBCXpr2XFm0jkECxgrpXBW2ipoAw==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/scope-manager": "8.41.0", - "@typescript-eslint/types": "8.41.0", - "@typescript-eslint/typescript-estree": "8.41.0", - "@typescript-eslint/visitor-keys": "8.41.0", + "@typescript-eslint/scope-manager": "8.44.0", + "@typescript-eslint/types": "8.44.0", + "@typescript-eslint/typescript-estree": "8.44.0", + "@typescript-eslint/visitor-keys": "8.44.0", "debug": "^4.3.4" }, "engines": { @@ -1901,14 +1952,14 @@ } }, "node_modules/@typescript-eslint/project-service": { - "version": "8.41.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/project-service/-/project-service-8.41.0.tgz", - "integrity": "sha512-b8V9SdGBQzQdjJ/IO3eDifGpDBJfvrNTp2QD9P2BeqWTGrRibgfgIlBSw6z3b6R7dPzg752tOs4u/7yCLxksSQ==", + "version": "8.44.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/project-service/-/project-service-8.44.0.tgz", + "integrity": "sha512-ZeaGNraRsq10GuEohKTo4295Z/SuGcSq2LzfGlqiuEvfArzo/VRrT0ZaJsVPuKZ55lVbNk8U6FcL+ZMH8CoyVA==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/tsconfig-utils": "^8.41.0", - "@typescript-eslint/types": "^8.41.0", + "@typescript-eslint/tsconfig-utils": "^8.44.0", + "@typescript-eslint/types": "^8.44.0", "debug": "^4.3.4" }, "engines": { @@ -1923,14 +1974,14 @@ } }, "node_modules/@typescript-eslint/scope-manager": { - "version": "8.41.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.41.0.tgz", - "integrity": "sha512-n6m05bXn/Cd6DZDGyrpXrELCPVaTnLdPToyhBoFkLIMznRUQUEQdSp96s/pcWSQdqOhrgR1mzJ+yItK7T+WPMQ==", + "version": "8.44.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.44.0.tgz", + "integrity": "sha512-87Jv3E+al8wpD+rIdVJm/ItDBe/Im09zXIjFoipOjr5gHUhJmTzfFLuTJ/nPTMc2Srsroy4IBXwcTCHyRR7KzA==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.41.0", - "@typescript-eslint/visitor-keys": "8.41.0" + "@typescript-eslint/types": "8.44.0", + "@typescript-eslint/visitor-keys": "8.44.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -1941,9 +1992,9 @@ } }, "node_modules/@typescript-eslint/tsconfig-utils": { - "version": "8.41.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.41.0.tgz", - "integrity": "sha512-TDhxYFPUYRFxFhuU5hTIJk+auzM/wKvWgoNYOPcOf6i4ReYlOoYN8q1dV5kOTjNQNJgzWN3TUUQMtlLOcUgdUw==", + "version": "8.44.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.44.0.tgz", + "integrity": "sha512-x5Y0+AuEPqAInc6yd0n5DAcvtoQ/vyaGwuX5HE9n6qAefk1GaedqrLQF8kQGylLUb9pnZyLf+iEiL9fr8APDtQ==", "dev": true, "license": "MIT", "engines": { @@ -1958,15 +2009,15 @@ } }, "node_modules/@typescript-eslint/type-utils": { - "version": "8.41.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.41.0.tgz", - "integrity": "sha512-63qt1h91vg3KsjVVonFJWjgSK7pZHSQFKH6uwqxAH9bBrsyRhO6ONoKyXxyVBzG1lJnFAJcKAcxLS54N1ee1OQ==", + "version": "8.44.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.44.0.tgz", + "integrity": "sha512-9cwsoSxJ8Sak67Be/hD2RNt/fsqmWnNE1iHohG8lxqLSNY8xNfyY7wloo5zpW3Nu9hxVgURevqfcH6vvKCt6yg==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.41.0", - "@typescript-eslint/typescript-estree": "8.41.0", - "@typescript-eslint/utils": "8.41.0", + "@typescript-eslint/types": "8.44.0", + "@typescript-eslint/typescript-estree": "8.44.0", + "@typescript-eslint/utils": "8.44.0", "debug": "^4.3.4", "ts-api-utils": "^2.1.0" }, @@ -1983,9 +2034,9 @@ } }, "node_modules/@typescript-eslint/types": { - "version": "8.41.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.41.0.tgz", - "integrity": "sha512-9EwxsWdVqh42afLbHP90n2VdHaWU/oWgbH2P0CfcNfdKL7CuKpwMQGjwev56vWu9cSKU7FWSu6r9zck6CVfnag==", + "version": "8.44.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.44.0.tgz", + "integrity": "sha512-ZSl2efn44VsYM0MfDQe68RKzBz75NPgLQXuGypmym6QVOWL5kegTZuZ02xRAT9T+onqvM6T8CdQk0OwYMB6ZvA==", "dev": true, "license": "MIT", "engines": { @@ -1997,16 +2048,16 @@ } }, "node_modules/@typescript-eslint/typescript-estree": { - "version": "8.41.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.41.0.tgz", - "integrity": "sha512-D43UwUYJmGhuwHfY7MtNKRZMmfd8+p/eNSfFe6tH5mbVDto+VQCayeAt35rOx3Cs6wxD16DQtIKw/YXxt5E0UQ==", + "version": "8.44.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.44.0.tgz", + "integrity": "sha512-lqNj6SgnGcQZwL4/SBJ3xdPEfcBuhCG8zdcwCPgYcmiPLgokiNDKlbPzCwEwu7m279J/lBYWtDYL+87OEfn8Jw==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/project-service": "8.41.0", - "@typescript-eslint/tsconfig-utils": "8.41.0", - "@typescript-eslint/types": "8.41.0", - "@typescript-eslint/visitor-keys": "8.41.0", + "@typescript-eslint/project-service": "8.44.0", + "@typescript-eslint/tsconfig-utils": "8.44.0", + "@typescript-eslint/types": "8.44.0", + "@typescript-eslint/visitor-keys": "8.44.0", "debug": "^4.3.4", "fast-glob": "^3.3.2", "is-glob": "^4.0.3", @@ -2052,16 +2103,16 @@ } }, "node_modules/@typescript-eslint/utils": { - "version": "8.41.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.41.0.tgz", - "integrity": "sha512-udbCVstxZ5jiPIXrdH+BZWnPatjlYwJuJkDA4Tbo3WyYLh8NvB+h/bKeSZHDOFKfphsZYJQqaFtLeXEqurQn1A==", + "version": "8.44.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.44.0.tgz", + "integrity": "sha512-nktOlVcg3ALo0mYlV+L7sWUD58KG4CMj1rb2HUVOO4aL3K/6wcD+NERqd0rrA5Vg06b42YhF6cFxeixsp9Riqg==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/eslint-utils": "^4.7.0", - "@typescript-eslint/scope-manager": "8.41.0", - "@typescript-eslint/types": "8.41.0", - "@typescript-eslint/typescript-estree": "8.41.0" + "@typescript-eslint/scope-manager": "8.44.0", + "@typescript-eslint/types": "8.44.0", + "@typescript-eslint/typescript-estree": "8.44.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -2076,13 +2127,13 @@ } }, "node_modules/@typescript-eslint/visitor-keys": { - "version": "8.41.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.41.0.tgz", - "integrity": "sha512-+GeGMebMCy0elMNg67LRNoVnUFPIm37iu5CmHESVx56/9Jsfdpsvbv605DQ81Pi/x11IdKUsS5nzgTYbCQU9fg==", + "version": "8.44.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.44.0.tgz", + "integrity": "sha512-zaz9u8EJ4GBmnehlrpoKvj/E3dNbuQ7q0ucyZImm3cLqJ8INTc970B1qEqDX/Rzq65r3TvVTN7kHWPBoyW7DWw==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.41.0", + "@typescript-eslint/types": "8.44.0", "eslint-visitor-keys": "^4.2.1" }, "engines": { @@ -2510,9 +2561,9 @@ } }, "node_modules/debug": { - "version": "4.4.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.1.tgz", - "integrity": "sha512-KcKCqiftBJcZr++7ykoDIEwSa3XWowTfNPo92BYxjXiyYEVrUQh2aLyhxBCwww+heortUFxEJYcRzosstTEBYQ==", + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", "license": "MIT", "dependencies": { "ms": "^2.1.3" @@ -2627,19 +2678,19 @@ } }, "node_modules/eslint": { - "version": "9.34.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.34.0.tgz", - "integrity": "sha512-RNCHRX5EwdrESy3Jc9o8ie8Bog+PeYvvSR8sDGoZxNFTvZ4dlxUB3WzQ3bQMztFrSRODGrLLj8g6OFuGY/aiQg==", + "version": "9.35.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.35.0.tgz", + "integrity": "sha512-QePbBFMJFjgmlE+cXAlbHZbHpdFVS2E/6vzCy7aKlebddvl1vadiC4JFV5u/wqTkNUwEV8WrQi257jf5f06hrg==", "dev": true, "license": "MIT", "dependencies": { - "@eslint-community/eslint-utils": "^4.2.0", + "@eslint-community/eslint-utils": "^4.8.0", "@eslint-community/regexpp": "^4.12.1", "@eslint/config-array": "^0.21.0", "@eslint/config-helpers": "^0.3.1", "@eslint/core": "^0.15.2", "@eslint/eslintrc": "^3.3.1", - "@eslint/js": "9.34.0", + "@eslint/js": "9.35.0", "@eslint/plugin-kit": "^0.3.5", "@humanfs/node": "^0.16.6", "@humanwhocodes/module-importer": "^1.0.1", @@ -3043,9 +3094,9 @@ } }, "node_modules/globals": { - "version": "16.3.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-16.3.0.tgz", - "integrity": "sha512-bqWEnJ1Nt3neqx2q5SFfGS8r/ahumIakg3HcwtNlrVlwXIeNumWn/c7Pn/wKzGhf6SaW6H6uWXLqC30STCMchQ==", + "version": "16.4.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-16.4.0.tgz", + "integrity": "sha512-ob/2LcVVaVGCYN+r14cnwnoDPUufjiYgSqRhiFD0Q1iI4Odora5RE8Iv1D24hAz5oMophRGkGz+yuvQmmUMnMw==", "dev": true, "license": "MIT", "engines": { @@ -3386,9 +3437,9 @@ } }, "node_modules/marked": { - "version": "16.2.1", - "resolved": "https://registry.npmjs.org/marked/-/marked-16.2.1.tgz", - "integrity": "sha512-r3UrXED9lMlHF97jJByry90cwrZBBvZmjG1L68oYfuPMW+uDTnuMbyJDymCWwbTE+f+3LhpNDKfpR3a3saFyjA==", + "version": "16.3.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-16.3.0.tgz", + "integrity": "sha512-K3UxuKu6l6bmA5FUwYho8CfJBlsUWAooKtdGgMcERSpF7gcBUrCGsLH7wDaaNOzwq18JzSUDyoEb/YsrqMac3w==", "license": "MIT", "bin": { "marked": "bin/marked.js" @@ -4253,16 +4304,16 @@ } }, "node_modules/typescript-eslint": { - "version": "8.41.0", - "resolved": "https://registry.npmjs.org/typescript-eslint/-/typescript-eslint-8.41.0.tgz", - "integrity": "sha512-n66rzs5OBXW3SFSnZHr2T685q1i4ODm2nulFJhMZBotaTavsS8TrI3d7bDlRSs9yWo7HmyWrN9qDu14Qv7Y0Dw==", + "version": "8.44.0", + "resolved": "https://registry.npmjs.org/typescript-eslint/-/typescript-eslint-8.44.0.tgz", + "integrity": "sha512-ib7mCkYuIzYonCq9XWF5XNw+fkj2zg629PSa9KNIQ47RXFF763S5BIX4wqz1+FLPogTZoiw8KmCiRPRa8bL3qw==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/eslint-plugin": "8.41.0", - "@typescript-eslint/parser": "8.41.0", - "@typescript-eslint/typescript-estree": "8.41.0", - "@typescript-eslint/utils": "8.41.0" + "@typescript-eslint/eslint-plugin": "8.44.0", + "@typescript-eslint/parser": "8.44.0", + "@typescript-eslint/typescript-estree": "8.44.0", + "@typescript-eslint/utils": "8.44.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -4687,9 +4738,9 @@ } }, "node_modules/zod": { - "version": "4.1.5", - "resolved": "https://registry.npmjs.org/zod/-/zod-4.1.5.tgz", - "integrity": "sha512-rcUUZqlLJgBC33IT3PNMgsCq6TzLQEG/Ei/KTCU0PedSWRMAXoOUN+4t/0H+Q8bdnLPdqUYnvboJT0bn/229qg==", + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/zod/-/zod-4.1.8.tgz", + "integrity": "sha512-5R1P+WwQqmmMIEACyzSvo4JXHY5WiAFHRMg+zBZKgKS+Q1viRa0C1hmUKtHltoIFKtIdki3pRxkmpP74jnNYHQ==", "license": "MIT", "funding": { "url": "https://github.com/sponsors/colinhacks" diff --git a/.github/package.json b/.github/package.json index ce72dfece6b1..9c1015527864 100644 --- a/.github/package.json +++ b/.github/package.json @@ -6,20 +6,20 @@ "dependencies2": "All runtime and dev dependencies in this file, must be a superset of shared/package.json" }, "dependencies": { - "@apidevtools/json-schema-ref-parser": "^14.1.1", - "debug": "^4.4.0", + "@apidevtools/json-schema-ref-parser": "^14.2.1", + "debug": "^4.4.3", "js-yaml": "^4.1.0", - "marked": "^16.1.1", + "marked": "^16.3.0", "markdown-table": "^3.0.4", "simple-git": "^3.27.0", - "zod": "^4.0.2" + "zod": "^4.1.8" }, "devDependencies": { "@actions/github-script": "github:actions/github-script", "@eslint/js": "^9.22.0", "@octokit/endpoint": "^11.0.0", "@octokit/rest": "^22.0.0", - "@octokit/types": "^14.1.0", + "@octokit/types": "^15.0.0", "@octokit/webhooks-types": "^7.5.1", "@tsconfig/node20": "^20.1.4", "@types/debug": "^4.1.12", diff --git a/.github/shared/package-lock.json b/.github/shared/package-lock.json index 2e0b9901f3d3..8b54490a9bfc 100644 --- a/.github/shared/package-lock.json +++ b/.github/shared/package-lock.json @@ -6,10 +6,10 @@ "": { "name": "@azure-tools/specs-shared", "dependencies": { - "@apidevtools/json-schema-ref-parser": "^14.1.1", - "debug": "^4.4.0", + "@apidevtools/json-schema-ref-parser": "^14.2.1", + "debug": "^4.4.3", "js-yaml": "^4.1.0", - "marked": "^16.1.1", + "marked": "^16.3.0", "simple-git": "^3.27.0" }, "bin": { @@ -47,9 +47,9 @@ } }, "node_modules/@apidevtools/json-schema-ref-parser": { - "version": "14.2.0", - "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-14.2.0.tgz", - "integrity": "sha512-NaGMMWwppbByagq+LwQMq6PMXHFWVu6kSwwx+eJfYTJ5zdpOvb9TIk6ZWxEEeXMUvGdVOZq3JalYsjsTZDvtkA==", + "version": "14.2.1", + "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-14.2.1.tgz", + "integrity": "sha512-HmdFw9CDYqM6B25pqGBpNeLCKvGPlIx1EbLrVL0zPvj50CJQUHyBNBw45Muk0kEIkogo1VZvOKHajdMuAzSxRg==", "license": "MIT", "dependencies": { "js-yaml": "^4.1.0" @@ -567,9 +567,9 @@ } }, "node_modules/@eslint-community/eslint-utils": { - "version": "4.7.0", - "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.7.0.tgz", - "integrity": "sha512-dyybb3AcajC7uha6CvhdVRJqaKyn7w2YKqKyAN37NKYgZT36w+iRb0Dymmc5qEJ549c/S31cMMSFd75bteCpCw==", + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.9.0.tgz", + "integrity": "sha512-ayVFHdtZ+hsq1t2Dy24wCmGXGe4q9Gu3smhLYALJrr473ZH27MsnSL+LKUlimp4BWJqMDMLmPpx/Q9R3OAlL4g==", "dev": true, "license": "MIT", "dependencies": { @@ -684,9 +684,9 @@ } }, "node_modules/@eslint/js": { - "version": "9.34.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.34.0.tgz", - "integrity": "sha512-EoyvqQnBNsV1CWaEJ559rxXL4c8V92gxirbawSmVUOWXlsRxxQXl6LmCpdUblgxgSkDIqKnhzba2SjRTI/A5Rw==", + "version": "9.35.0", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.35.0.tgz", + "integrity": "sha512-30iXE9whjlILfWobBkNerJo+TXYsgVM5ERQwMcMKCHckHflCmf7wXDAHlARoWnh0s1U72WqlbeyE7iAcCzuCPw==", "dev": true, "license": "MIT", "engines": { @@ -1620,9 +1620,9 @@ } }, "node_modules/debug": { - "version": "4.4.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.1.tgz", - "integrity": "sha512-KcKCqiftBJcZr++7ykoDIEwSa3XWowTfNPo92BYxjXiyYEVrUQh2aLyhxBCwww+heortUFxEJYcRzosstTEBYQ==", + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", "license": "MIT", "dependencies": { "ms": "^2.1.3" @@ -1730,19 +1730,19 @@ } }, "node_modules/eslint": { - "version": "9.34.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.34.0.tgz", - "integrity": "sha512-RNCHRX5EwdrESy3Jc9o8ie8Bog+PeYvvSR8sDGoZxNFTvZ4dlxUB3WzQ3bQMztFrSRODGrLLj8g6OFuGY/aiQg==", + "version": "9.35.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.35.0.tgz", + "integrity": "sha512-QePbBFMJFjgmlE+cXAlbHZbHpdFVS2E/6vzCy7aKlebddvl1vadiC4JFV5u/wqTkNUwEV8WrQi257jf5f06hrg==", "dev": true, "license": "MIT", "dependencies": { - "@eslint-community/eslint-utils": "^4.2.0", + "@eslint-community/eslint-utils": "^4.8.0", "@eslint-community/regexpp": "^4.12.1", "@eslint/config-array": "^0.21.0", "@eslint/config-helpers": "^0.3.1", "@eslint/core": "^0.15.2", "@eslint/eslintrc": "^3.3.1", - "@eslint/js": "9.34.0", + "@eslint/js": "9.35.0", "@eslint/plugin-kit": "^0.3.5", "@humanfs/node": "^0.16.6", "@humanwhocodes/module-importer": "^1.0.1", @@ -2087,9 +2087,9 @@ } }, "node_modules/globals": { - "version": "16.3.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-16.3.0.tgz", - "integrity": "sha512-bqWEnJ1Nt3neqx2q5SFfGS8r/ahumIakg3HcwtNlrVlwXIeNumWn/c7Pn/wKzGhf6SaW6H6uWXLqC30STCMchQ==", + "version": "16.4.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-16.4.0.tgz", + "integrity": "sha512-ob/2LcVVaVGCYN+r14cnwnoDPUufjiYgSqRhiFD0Q1iI4Odora5RE8Iv1D24hAz5oMophRGkGz+yuvQmmUMnMw==", "dev": true, "license": "MIT", "engines": { @@ -2403,9 +2403,9 @@ } }, "node_modules/marked": { - "version": "16.2.1", - "resolved": "https://registry.npmjs.org/marked/-/marked-16.2.1.tgz", - "integrity": "sha512-r3UrXED9lMlHF97jJByry90cwrZBBvZmjG1L68oYfuPMW+uDTnuMbyJDymCWwbTE+f+3LhpNDKfpR3a3saFyjA==", + "version": "16.3.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-16.3.0.tgz", + "integrity": "sha512-K3UxuKu6l6bmA5FUwYho8CfJBlsUWAooKtdGgMcERSpF7gcBUrCGsLH7wDaaNOzwq18JzSUDyoEb/YsrqMac3w==", "license": "MIT", "bin": { "marked": "bin/marked.js" diff --git a/.github/shared/package.json b/.github/shared/package.json index 4be4dba5e740..43a43b1636b1 100644 --- a/.github/shared/package.json +++ b/.github/shared/package.json @@ -34,10 +34,10 @@ "dependencies2": "All runtime and dev dependencies in this file, must be a subset of ../package.json" }, "dependencies": { - "@apidevtools/json-schema-ref-parser": "^14.1.1", - "debug": "^4.4.0", + "@apidevtools/json-schema-ref-parser": "^14.2.1", + "debug": "^4.4.3", "js-yaml": "^4.1.0", - "marked": "^16.1.1", + "marked": "^16.3.0", "simple-git": "^3.27.0" }, "devDependencies": { diff --git a/dev/cognitiveservices/data-plane/Language/analyzeconversations-authoring.json b/dev/cognitiveservices/data-plane/Language/analyzeconversations-authoring.json deleted file mode 100644 index 78906d295c9a..000000000000 --- a/dev/cognitiveservices/data-plane/Language/analyzeconversations-authoring.json +++ /dev/null @@ -1,3267 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Analyze Conversations Authoring", - "version": "2023-04-01", - "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}/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}/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" - } - }, - "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" - }, - "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" - }, - "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" - } - }, - "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\". 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", - "hasSnapshot" - ], - "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" - }, - "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": { - "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" - ], - "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/dev/cognitiveservices/data-plane/Language/analyzeconversations.json b/dev/cognitiveservices/data-plane/Language/analyzeconversations.json deleted file mode 100644 index bce20f237502..000000000000 --- a/dev/cognitiveservices/data-plane/Language/analyzeconversations.json +++ /dev/null @@ -1,2215 +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-01" - }, - "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": "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 Conversation Summarization Analysis Job Request": { - "$ref": "./examples/conversations/SuccessfulConversationSummarySubmit.json" - }, - "Successful Conversation Summarization Task Submit": { - "$ref": "./examples/conversations/SuccessfulConversationSummarizationTaskSubmit.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 Text Conversation Analysis Job Status Request": { - "$ref": "./examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.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 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": "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": "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": [ - "ConversationalSummarizationTask" - ], - "x-ms-enum": { - "name": "AnalyzeConversationLROTaskKind", - "modelAsString": true - } - }, - "AnalyzeConversationResultsKind": { - "type": "string", - "description": "Enumeration of results for supported conversation analysis tasks.", - "enum": [ - "ConversationalSummarizationResults" - ], - "x-ms-enum": { - "name": "AnalyzeConversationResultsKind", - "modelAsString": true - } - }, - "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" - ] - }, - "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" - } - } - }, - "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" - } - ] - }, - "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" - ] - }, - "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/dev/cognitiveservices/data-plane/Language/analyzedocuments.json b/dev/cognitiveservices/data-plane/Language/analyzedocuments.json deleted file mode 100644 index 56a63b03726c..000000000000 --- a/dev/cognitiveservices/data-plane/Language/analyzedocuments.json +++ /dev/null @@ -1,2235 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Document 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-11-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": [ - { - "name": "Endpoint", - "in": "path", - "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", - "required": true, - "type": "string" - } - ] - }, - "paths": { - "/analyze-documents/jobs": { - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "description": "Submit a collection of documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.", - "operationId": "AnalyzeDocuments_SubmitJob", - "summary": "Submit document 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/AnalyzeDocumentJobsInput" - }, - "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-long-running-operation": true, - "x-ms-examples": { - "Successful PII redaction Request": { - "$ref": "./examples/analyzedocuments/SuccessfulPiiTaskSubmit.json" - } - } - } - }, - "/analyze-documents/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": "AnalyzeDocuments_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/AnalyzeDocumentsJobState" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful PII redaction Result": { - "$ref": "./examples/analyzedocuments/SuccessfulPiiTaskResult.json" - } - } - } - }, - "/analyze-documents/jobs/{jobId}:cancel": { - "post": { - "produces": [ - "application/json" - ], - "description": "Cancel a long-running Document Analysis job.", - "operationId": "AnalyzeDocuments_CancelJob", - "summary": "Cancel a long-running Document Analysis job", - "parameters": [ - { - "$ref": "common.json#/parameters/ApiVersionParameter" - }, - { - "$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-long-running-operation": true, - "x-ms-examples": { - "Successful job cancellation request": { - "$ref": "./examples/analyzedocuments/SuccessfulAnalyzeTextJobsCancelRequest.json" - } - } - } - } - }, - "definitions": { - "AnalyzeDocumentJobsInput": { - "type": "object", - "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/AnalyzeDocumentsLROTask" - } - } - }, - "required": [ - "analysisInput", - "tasks" - ] - }, - "MultiLanguageAnalysisInput": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/definitions/MultiLanguageInput" - } - } - } - }, - "MultiLanguageInput": { - "type": "object", - "description": "Contains an input document to be analyzed by the service.", - "required": [ - "id", - "source", - "target" - ], - "properties": { - "id": { - "type": "string", - "description": "A unique, non-empty document identifier." - }, - "source": { - "$ref": "#/definitions/DocumentLocation" - }, - "target": { - "$ref": "#/definitions/DocumentLocation" - }, - "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." - } - } - }, - "DocumentLocation": { - "type": "object", - "discriminator": "kind", - "properties": { - "kind": { - "$ref": "#/definitions/DocumentLocationKind" - } - }, - "required": [ - "kind" - ] - }, - "AzureBlobDocumentLocation": { - "type": "object", - "properties": { - "location": { - "description": "Location of the file to process", - "type": "string", - "example": "https://myblob.blob.core.windows.net/Container/document.pdf" - }, - "managedIdentityClientId": { - "description": "The managed identity client Id to use to authenticate with the storage account", - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/definitions/DocumentLocation" - } - ], - "required": [ - "location" - ], - "x-ms-discriminator-value": "AzureBlob" - }, - "DocumentLocationKind": { - "type": "string", - "description": "Enumeration of supported document locations.", - "enum": [ - "AzureBlob" - ], - "x-ms-enum": { - "name": "DocumentLocationKind", - "modelAsString": true, - "values": [ - { - "name": "AzureBlob", - "value": "AzureBlob", - "description": "The document is a URL." - } - ] - } - }, - "AnalyzeDocumentsLROTask": { - "type": "object", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeDocumentsLROTaskKind" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskIdentifier" - } - ] - }, - "AnalyzeDocumentsLROTaskKind": { - "type": "string", - "description": "Enumeration of supported long-running Document Analysis tasks.", - "enum": [ - "PiiEntityRecognition", - "ExtractiveSummarization", - "AbstractiveSummarization" - ], - "x-ms-enum": { - "name": "AnalyzeDocumentsLROTaskKind", - "modelAsString": true - } - }, - "AnalyzeDocumentsJobState": { - "allOf": [ - { - "$ref": "common.json#/definitions/JobState" - }, - { - "$ref": "#/definitions/TasksState" - }, - { - "$ref": "#/definitions/AnalyzeDocumentsJobStatistics" - } - ] - }, - "AnalyzeDocumentsJobStatistics": { - "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/AnalyzeDocumentsLROResult" - } - } - }, - "required": [ - "total", - "completed", - "failed", - "inProgress" - ], - "type": "object" - } - }, - "required": [ - "tasks" - ], - "type": "object" - }, - "AnalyzeDocumentsLROResult": { - "type": "object", - "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeDocumentsLROResultsKind" - }, - "results": { - "$ref": "#/definitions/AnalyzeDocumentsLROTaskResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskState" - }, - { - "$ref": "#/definitions/TaskIdentifier" - } - ], - "required": [ - "kind" - ] - }, - "AnalyzeDocumentsLROResultsKind": { - "type": "string", - "description": "Enumeration of supported Document Analysis long-running operation task results.", - "enum": [ - "PiiEntityRecognitionLROResults", - "ExtractiveSummarizationLROResults", - "AbstractiveSummarizationLROResults" - ], - "x-ms-enum": { - "name": "AnalyzeDocumentsLROResultsKind", - "modelAsString": true - } - }, - "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" - }, - "AnalyzeDocumentsLROTaskResult": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Response by document", - "items": { - "$ref": "#/definitions/DocumentResultWithDetectedLanguage" - } - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], - "required": [ - "documents" - ] - }, - "DocumentResultWithDetectedLanguage": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - }, - "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." - } - } - }, - "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." - } - } - }, - "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" - }, - "source": { - "$ref": "#/definitions/DocumentLocation", - "description": "The location of the input document." - }, - "target": { - "type": "array", - "description": "The location of the result files.", - "items": { - "$ref": "#/definitions/DocumentLocation" - } - } - } - }, - "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." - }, - "PiiLROTask": { - "type": "object", - "description": "An object representing the task definition for a PII Entities Recognition task.", - "properties": { - "parameters": { - "$ref": "#/definitions/PiiTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeDocumentsLROTask" - } - ], - "x-ms-discriminator-value": "PiiEntityRecognition" - }, - "PiiCategory": { - "type": "string", - "description": "(Optional) describes the PII categories to return", - "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" - ], - "x-ms-enum": { - "name": "PiiCategory", - "modelAsString": true, - "values": [ - { - "name": "ABARoutingNumber", - "value": "ABARoutingNumber", - "description": "ABA Routing number" - }, - { - "name": "ARNationalIdentityNumber", - "value": "ARNationalIdentityNumber", - "description": "AR National Identity Number" - }, - { - "name": "AUBankAccountNumber", - "value": "AUBankAccountNumber", - "description": "AT Identity Card" - }, - { - "name": "AUDriversLicenseNumber", - "value": "AUDriversLicenseNumber", - "description": "AU Driver's License Number" - }, - { - "name": "AUMedicalAccountNumber", - "value": "AUMedicalAccountNumber", - "description": "AU Medical Account Number" - }, - { - "name": "AUPassportNumber", - "value": "AUPassportNumber", - "description": "AU Passport Number" - }, - { - "name": "AUTaxFileNumber", - "value": "AUTaxFileNumber", - "description": "AU Tax File Number" - }, - { - "name": "AUBusinessNumber", - "value": "AUBusinessNumber", - "description": "AU Business Number" - }, - { - "name": "AUCompanyNumber", - "value": "AUCompanyNumber", - "description": "AU Company Number" - }, - { - "name": "ATIdentityCard", - "value": "ATIdentityCard", - "description": "AT Identity Card" - }, - { - "name": "ATTaxIdentificationNumber", - "value": "ATTaxIdentificationNumber", - "description": "AT Tax Identification Number" - }, - { - "name": "ATValueAddedTaxNumber", - "value": "ATValueAddedTaxNumber", - "description": "AT Value Added Tax Number" - }, - { - "name": "AzureDocumentDBAuthKey", - "value": "AzureDocumentDBAuthKey", - "description": "Azure Document DB Auth Key" - }, - { - "name": "AzureIAASDatabaseConnectionAndSQLString", - "value": "AzureIAASDatabaseConnectionAndSQLString", - "description": "Azure IAAS Database Connection And SQL String" - }, - { - "name": "AzureIoTConnectionString", - "value": "AzureIoTConnectionString", - "description": "Azure IoT Connection String" - }, - { - "name": "AzurePublishSettingPassword", - "value": "AzurePublishSettingPassword", - "description": "Azure Publish Setting Password" - }, - { - "name": "AzureRedisCacheString", - "value": "AzureRedisCacheString", - "description": "Azure Redis Cache String" - }, - { - "name": "AzureSAS", - "value": "AzureSAS", - "description": "Azure SAS" - }, - { - "name": "AzureServiceBusString", - "value": "AzureServiceBusString", - "description": "Azure Service Bus String" - }, - { - "name": "AzureStorageAccountKey", - "value": "AzureStorageAccountKey", - "description": "Azure Storage Account Key" - }, - { - "name": "AzureStorageAccountGeneric", - "value": "AzureStorageAccountGeneric", - "description": "Azure Storage Account Generic" - }, - { - "name": "BENationalNumber", - "value": "BENationalNumber", - "description": "BE National Number" - }, - { - "name": "BENationalNumberV2", - "value": "BENationalNumberV2", - "description": "BE National Number V2" - }, - { - "name": "BEValueAddedTaxNumber", - "value": "BEValueAddedTaxNumber", - "description": "BE Value Added Tax Number" - }, - { - "name": "BRCPFNumber", - "value": "BRCPFNumber", - "description": "BR CPF Number" - }, - { - "name": "BRLegalEntityNumber", - "value": "BRLegalEntityNumber", - "description": "BR Legal Entity Number" - }, - { - "name": "BRNationalIDRG", - "value": "BRNationalIDRG", - "description": "BR National ID RG" - }, - { - "name": "BGUniformCivilNumber", - "value": "BGUniformCivilNumber", - "description": "BG Uniform Civil Number" - }, - { - "name": "CABankAccountNumber", - "value": "CABankAccountNumber", - "description": "CA Bank Account Number" - }, - { - "name": "CADriversLicenseNumber", - "value": "CADriversLicenseNumber", - "description": "CA Driver's License Number" - }, - { - "name": "CAHealthServiceNumber", - "value": "CAHealthServiceNumber", - "description": "CA Health Service Number" - }, - { - "name": "CAPassportNumber", - "value": "CAPassportNumber", - "description": "CA Passport Number" - }, - { - "name": "CAPersonalHealthIdentification", - "value": "CAPersonalHealthIdentification", - "description": "CA Personal Health Identification" - }, - { - "name": "CASocialInsuranceNumber", - "value": "CASocialInsuranceNumber", - "description": "CA Social Insurance Number" - }, - { - "name": "CLIdentityCardNumber", - "value": "CLIdentityCardNumber", - "description": "CL Identity Card Number" - }, - { - "name": "CNResidentIdentityCardNumber", - "value": "CNResidentIdentityCardNumber", - "description": "CN Resident Identity Card Number" - }, - { - "name": "CreditCardNumber", - "value": "CreditCardNumber", - "description": "Credit Card Number" - }, - { - "name": "HRIdentityCardNumber", - "value": "HRIdentityCardNumber", - "description": "HR Identity Card Number" - }, - { - "name": "HRNationalIDNumber", - "value": "HRNationalIDNumber", - "description": "HR National ID Number" - }, - { - "name": "HRPersonalIdentificationNumber", - "value": "HRPersonalIdentificationNumber", - "description": "HR Personal Identification Number" - }, - { - "name": "HRPersonalIdentificationOIBNumberV2", - "value": "HRPersonalIdentificationOIBNumberV2", - "description": "HR Personal Identification OIB Number V2" - }, - { - "name": "CYIdentityCard", - "value": "CYIdentityCard", - "description": "CY Identity Card" - }, - { - "name": "CYTaxIdentificationNumber", - "value": "CYTaxIdentificationNumber", - "description": "CY Tax Identification Number" - }, - { - "name": "CZPersonalIdentityNumber", - "value": "CZPersonalIdentityNumber", - "description": "CZ Personal Identity Number" - }, - { - "name": "CZPersonalIdentityV2", - "value": "CZPersonalIdentityV2", - "description": "CZ Personal Identity V2" - }, - { - "name": "DKPersonalIdentificationNumber", - "value": "DKPersonalIdentificationNumber", - "description": "DK Personal Identification Number" - }, - { - "name": "DKPersonalIdentificationV2", - "value": "DKPersonalIdentificationV2", - "description": "DK Personal Identification V2" - }, - { - "name": "DrugEnforcementAgencyNumber", - "value": "DrugEnforcementAgencyNumber", - "description": "Drug Enforcement Agency Number" - }, - { - "name": "EEPersonalIdentificationCode", - "value": "EEPersonalIdentificationCode", - "description": "EE Personal Identification Code" - }, - { - "name": "EUDebitCardNumber", - "value": "EUDebitCardNumber", - "description": "EU Debit Card Number" - }, - { - "name": "EUDriversLicenseNumber", - "value": "EUDriversLicenseNumber", - "description": "EU Driver's License Number" - }, - { - "name": "EUGPSCoordinates", - "value": "EUGPSCoordinates", - "description": "EU GPS Coordinates" - }, - { - "name": "EUNationalIdentificationNumber", - "value": "EUNationalIdentificationNumber", - "description": "EU National Identification Number" - }, - { - "name": "EUPassportNumber", - "value": "EUPassportNumber", - "description": "EU Passport Number" - }, - { - "name": "EUSocialSecurityNumber", - "value": "EUSocialSecurityNumber", - "description": "EU Social Security Number" - }, - { - "name": "EUTaxIdentificationNumber", - "value": "EUTaxIdentificationNumber", - "description": "EU Tax Identification Number" - }, - { - "name": "FIEuropeanHealthNumber", - "value": "FIEuropeanHealthNumber", - "description": "FI European Health Number" - }, - { - "name": "FINationalID", - "value": "FINationalID", - "description": "FI National ID" - }, - { - "name": "FINationalIDV2", - "value": "FINationalIDV2", - "description": "FI National ID V2" - }, - { - "name": "FIPassportNumber", - "value": "FIPassportNumber", - "description": "FI Passport Number" - }, - { - "name": "FRDriversLicenseNumber", - "value": "FRDriversLicenseNumber", - "description": "FR Driver's License Number" - }, - { - "name": "FRHealthInsuranceNumber", - "value": "FRHealthInsuranceNumber", - "description": "FR Health Insurance Number" - }, - { - "name": "FRNationalID", - "value": "FRNationalID", - "description": "FR National ID" - }, - { - "name": "FRPassportNumber", - "value": "FRPassportNumber", - "description": "FR Passport Number" - }, - { - "name": "FRSocialSecurityNumber", - "value": "FRSocialSecurityNumber", - "description": "FR Social Security Number" - }, - { - "name": "FRTaxIdentificationNumber", - "value": "FRTaxIdentificationNumber", - "description": "FR Tax Identification Number" - }, - { - "name": "FRValueAddedTaxNumber", - "value": "FRValueAddedTaxNumber", - "description": "FR Value Added Tax Number" - }, - { - "name": "DEDriversLicenseNumber", - "value": "DEDriversLicenseNumber", - "description": "DE Driver's License Number" - }, - { - "name": "DEPassportNumber", - "value": "DEPassportNumber", - "description": "DE Passport Number" - }, - { - "name": "DEIdentityCardNumber", - "value": "DEIdentityCardNumber", - "description": "DE Identity Card Number" - }, - { - "name": "DETaxIdentificationNumber", - "value": "DETaxIdentificationNumber", - "description": "DE Tax Identification Number" - }, - { - "name": "DEValueAddedNumber", - "value": "DEValueAddedNumber", - "description": "DE Value Added Number" - }, - { - "name": "GRNationalIDCard", - "value": "GRNationalIDCard", - "description": "GR National ID Card" - }, - { - "name": "GRNationalIDV2", - "value": "GRNationalIDV2", - "description": "GR National ID V2" - }, - { - "name": "GRTaxIdentificationNumber", - "value": "GRTaxIdentificationNumber", - "description": "GR Tax Identification Number" - }, - { - "name": "HKIdentityCardNumber", - "value": "HKIdentityCardNumber", - "description": "HK Identity Card Number" - }, - { - "name": "HUValueAddedNumber", - "value": "HUValueAddedNumber", - "description": "HU Value Added Number" - }, - { - "name": "HUPersonalIdentificationNumber", - "value": "HUPersonalIdentificationNumber", - "description": "HU Personal Identification Number" - }, - { - "name": "HUTaxIdentificationNumber", - "value": "HUTaxIdentificationNumber", - "description": "HU Tax Identification Number" - }, - { - "name": "INPermanentAccount", - "value": "INPermanentAccount", - "description": "IN Permanent Account" - }, - { - "name": "INUniqueIdentificationNumber", - "value": "INUniqueIdentificationNumber", - "description": "IN Unique Identification Number" - }, - { - "name": "IDIdentityCardNumber", - "value": "IDIdentityCardNumber", - "description": "ID Identity Card Number" - }, - { - "name": "InternationalBankingAccountNumber", - "value": "InternationalBankingAccountNumber", - "description": "International Banking Account Number" - }, - { - "name": "IEPersonalPublicServiceNumber", - "value": "IEPersonalPublicServiceNumber", - "description": "IE Personal Public Service Number" - }, - { - "name": "IEPersonalPublicServiceNumberV2", - "value": "IEPersonalPublicServiceNumberV2", - "description": "IE Personal Public Service Number V2" - }, - { - "name": "ILBankAccountNumber", - "value": "ILBankAccountNumber", - "description": "IL Bank Account Number" - }, - { - "name": "ILNationalID", - "value": "ILNationalID", - "description": "IL National ID" - }, - { - "name": "ITDriversLicenseNumber", - "value": "ITDriversLicenseNumber", - "description": "IT Driver's License Number" - }, - { - "name": "ITFiscalCode", - "value": "ITFiscalCode", - "description": "IT Fiscal Code" - }, - { - "name": "ITValueAddedTaxNumber", - "value": "ITValueAddedTaxNumber", - "description": "IT Value Added Tax Number" - }, - { - "name": "JPBankAccountNumber", - "value": "JPBankAccountNumber", - "description": "JP Bank Account Number" - }, - { - "name": "JPDriversLicenseNumber", - "value": "JPDriversLicenseNumber", - "description": "JP Driver's License Number" - }, - { - "name": "JPPassportNumber", - "value": "JPPassportNumber", - "description": "JP Passport Number" - }, - { - "name": "JPResidentRegistrationNumber", - "value": "JPResidentRegistrationNumber", - "description": "JP Resident Registration Number" - }, - { - "name": "JPSocialInsuranceNumber", - "value": "JPSocialInsuranceNumber", - "description": "JP Social Insurance Number" - }, - { - "name": "JPMyNumberCorporate", - "value": "JPMyNumberCorporate", - "description": "JP My Number Corporate" - }, - { - "name": "JPMyNumberPersonal", - "value": "JPMyNumberPersonal", - "description": "JP My Number Personal" - }, - { - "name": "JPResidenceCardNumber", - "value": "JPResidenceCardNumber", - "description": "JP Residence Card Number" - }, - { - "name": "LVPersonalCode", - "value": "LVPersonalCode", - "description": "LV Personal Code" - }, - { - "name": "LTPersonalCode", - "value": "LTPersonalCode", - "description": "LT Personal Code" - }, - { - "name": "LUNationalIdentificationNumberNatural", - "value": "LUNationalIdentificationNumberNatural", - "description": "LU National Identification Number Natural" - }, - { - "name": "LUNationalIdentificationNumberNonNatural", - "value": "LUNationalIdentificationNumberNonNatural", - "description": "LU National Identification Number Non Natural" - }, - { - "name": "MYIdentityCardNumber", - "value": "MYIdentityCardNumber", - "description": "MY Identity Card Number" - }, - { - "name": "MTIdentityCardNumber", - "value": "MTIdentityCardNumber", - "description": "MT Identity Card Number" - }, - { - "name": "MTTaxIDNumber", - "value": "MTTaxIDNumber", - "description": "MT Tax ID Number" - }, - { - "name": "NLCitizensServiceNumber", - "value": "NLCitizensServiceNumber", - "description": "NL Citizens Service Number" - }, - { - "name": "NLCitizensServiceNumberV2", - "value": "NLCitizensServiceNumberV2", - "description": "NL Citizens Service Number V2" - }, - { - "name": "NLTaxIdentificationNumber", - "value": "NLTaxIdentificationNumber", - "description": "NL Tax Identification Number" - }, - { - "name": "NLValueAddedTaxNumber", - "value": "NLValueAddedTaxNumber", - "description": "NL Value Added Tax Number" - }, - { - "name": "NZBankAccountNumber", - "value": "NZBankAccountNumber", - "description": "NZ Bank Account Number" - }, - { - "name": "NZDriversLicenseNumber", - "value": "NZDriversLicenseNumber", - "description": "NZ Driver's License Number" - }, - { - "name": "NZInlandRevenueNumber", - "value": "NZInlandRevenueNumber", - "description": "NZ Inland Revenue Number" - }, - { - "name": "NZMinistryOfHealthNumber", - "value": "NZMinistryOfHealthNumber", - "description": "NZ Ministry Of Health Number" - }, - { - "name": "NZSocialWelfareNumber", - "value": "NZSocialWelfareNumber", - "description": "NZ Social Welfare Number" - }, - { - "name": "NOIdentityNumber", - "value": "NOIdentityNumber", - "description": "NO Identity Number" - }, - { - "name": "PHUnifiedMultiPurposeIDNumber", - "value": "PHUnifiedMultiPurposeIDNumber", - "description": "PH Unified Multi Purpose ID Number" - }, - { - "name": "PLIdentityCard", - "value": "PLIdentityCard", - "description": "PL Identity Card" - }, - { - "name": "PLNationalID", - "value": "PLNationalID", - "description": "PL National ID" - }, - { - "name": "PLNationalIDV2", - "value": "PLNationalIDV2", - "description": "PL National ID V2" - }, - { - "name": "PLPassportNumber", - "value": "PLPassportNumber", - "description": "PL Passport Number" - }, - { - "name": "PLTaxIdentificationNumber", - "value": "PLTaxIdentificationNumber", - "description": "PL Tax Identification Number" - }, - { - "name": "PLREGONNumber", - "value": "PLREGONNumber", - "description": "PL REGON Number" - }, - { - "name": "PTCitizenCardNumber", - "value": "PTCitizenCardNumber", - "description": "PT Citizen Card Number" - }, - { - "name": "PTCitizenCardNumberV2", - "value": "PTCitizenCardNumberV2", - "description": "PT Citizen Card Number V2" - }, - { - "name": "PTTaxIdentificationNumber", - "value": "PTTaxIdentificationNumber", - "description": "PT Tax Identification Number" - }, - { - "name": "ROPersonalNumericalCode", - "value": "ROPersonalNumericalCode", - "description": "RO Personal Numerical Code" - }, - { - "name": "RUPassportNumberDomestic", - "value": "RUPassportNumberDomestic", - "description": "RU Passport Number Domestic" - }, - { - "name": "RUPassportNumberInternational", - "value": "RUPassportNumberInternational", - "description": "RU Passport Number International" - }, - { - "name": "SANationalID", - "value": "SANationalID", - "description": "SA National ID" - }, - { - "name": "SGNationalRegistrationIdentityCardNumber", - "value": "SGNationalRegistrationIdentityCardNumber", - "description": "SG National Registration Identity Card Number" - }, - { - "name": "SKPersonalNumber", - "value": "SKPersonalNumber", - "description": "SK Personal Number" - }, - { - "name": "SITaxIdentificationNumber", - "value": "SITaxIdentificationNumber", - "description": "SI Tax Identification Number" - }, - { - "name": "SIUniqueMasterCitizenNumber", - "value": "SIUniqueMasterCitizenNumber", - "description": "SI Unique Master Citizen Number" - }, - { - "name": "ZAIdentificationNumber", - "value": "ZAIdentificationNumber", - "description": "ZA Identification Number" - }, - { - "name": "KRResidentRegistrationNumber", - "value": "KRResidentRegistrationNumber", - "description": "KR Resident Registration Number" - }, - { - "name": "ESDNI", - "value": "ESDNI", - "description": "ES DNI" - }, - { - "name": "ESSocialSecurityNumber", - "value": "ESSocialSecurityNumber", - "description": "ES Social Security Number" - }, - { - "name": "ESTaxIdentificationNumber", - "value": "ESTaxIdentificationNumber", - "description": "ES Tax Identification Number" - }, - { - "name": "SQLServerConnectionString", - "value": "SQLServerConnectionString", - "description": "SQL Server Connection String" - }, - { - "name": "SENationalID", - "value": "SENationalID", - "description": "SE National ID" - }, - { - "name": "SENationalIDV2", - "value": "SENationalIDV2", - "description": "SE National ID V2" - }, - { - "name": "SEPassportNumber", - "value": "SEPassportNumber", - "description": "SE Passport Number" - }, - { - "name": "SETaxIdentificationNumber", - "value": "SETaxIdentificationNumber", - "description": "SE Tax Identification Number" - }, - { - "name": "SWIFTCode", - "value": "SWIFTCode", - "description": "SWIFT Code" - }, - { - "name": "CHSocialSecurityNumber", - "value": "CHSocialSecurityNumber", - "description": "CH Social Security Number" - }, - { - "name": "TWNationalID", - "value": "TWNationalID", - "description": "TW National ID" - }, - { - "name": "TWPassportNumber", - "value": "TWPassportNumber", - "description": "TW Passport Number" - }, - { - "name": "TWResidentCertificate", - "value": "TWResidentCertificate", - "description": "TW Resident Certificate" - }, - { - "name": "THPopulationIdentificationCode", - "value": "THPopulationIdentificationCode", - "description": "TH Population Identification Code" - }, - { - "name": "TRNationalIdentificationNumber", - "value": "TRNationalIdentificationNumber", - "description": "TR National Identification Number" - }, - { - "name": "UKDriversLicenseNumber", - "value": "UKDriversLicenseNumber", - "description": "UK Driver's License Number" - }, - { - "name": "UKElectoralRollNumber", - "value": "UKElectoralRollNumber", - "description": "UK Electoral Roll Number" - }, - { - "name": "UKNationalHealthNumber", - "value": "UKNationalHealthNumber", - "description": "UK National Health Number" - }, - { - "name": "UKNationalInsuranceNumber", - "value": "UKNationalInsuranceNumber", - "description": "UK National Insurance Number" - }, - { - "name": "UKUniqueTaxpayerNumber", - "value": "UKUniqueTaxpayerNumber", - "description": "UK Unique Taxpayer Number" - }, - { - "name": "USUKPassportNumber", - "value": "USUKPassportNumber", - "description": "US UK Passport Number" - }, - { - "name": "USBankAccountNumber", - "value": "USBankAccountNumber", - "description": "US Bank Account Number" - }, - { - "name": "USDriversLicenseNumber", - "value": "USDriversLicenseNumber", - "description": "US Driver's License Number" - }, - { - "name": "USIndividualTaxpayerIdentification", - "value": "USIndividualTaxpayerIdentification", - "description": "US Individual Taxpayer Identification" - }, - { - "name": "USSocialSecurityNumber", - "value": "USSocialSecurityNumber", - "description": "US Social Security Number" - }, - { - "name": "UAPassportNumberDomestic", - "value": "UAPassportNumberDomestic", - "description": "UA Passport Number Domestic" - }, - { - "name": "UAPassportNumberInternational", - "value": "UAPassportNumberInternational", - "description": "UA Passport Number International" - }, - { - "name": "Organization", - "value": "Organization", - "description": "Organization" - }, - { - "name": "Email", - "value": "Email", - "description": "Email" - }, - { - "name": "URL", - "value": "URL", - "description": "URL" - }, - { - "name": "Age", - "value": "Age", - "description": "Age" - }, - { - "name": "PhoneNumber", - "value": "PhoneNumber", - "description": "Phone Number" - }, - { - "name": "IPAddress", - "value": "IPAddress", - "description": "IP Address" - }, - { - "name": "Date", - "value": "Date", - "description": "Date" - }, - { - "name": "Person", - "value": "Person", - "description": "Person" - }, - { - "name": "Address", - "value": "Address", - "description": "Address" - }, - { - "name": "All", - "value": "All", - "description": "All PII categories." - }, - { - "name": "Default", - "value": "Default", - "description": "Default PII categories for the language." - } - ] - } - }, - "PiiTaskParameters": { - "type": "object", - "description": "Supported parameters for a PII Entities Recognition task.", - "properties": { - "domain": { - "$ref": "#/definitions/PiiDomain" - }, - "piiCategories": { - "$ref": "#/definitions/PiiCategory" - }, - "excludePiiCategories": { - "$ref": "#/definitions/PiiCategoriesExclude" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - }, - "redactionCharacter": { - "$ref": "#/definitions/RedactionCharacter" - } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "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" - } - ] - } - }, - "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 - }, - "PiiEntitiesDocumentResult": { - "type": "object", - "properties": { - "redactedText": { - "type": "string", - "description": "Returns redacted text." - }, - "entities": { - "type": "array", - "description": "Recognized entities in the document.", - "items": { - "$ref": "#/definitions/Entity" - } - } - }, - "required": [ - "redactedText", - "entities" - ] - }, - "Entity": { - "type": "object", - "required": [ - "text", - "category", - "reference-id", - "length", - "confidenceScore" - ], - "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "type": "string", - "description": "Category of the entity detected." - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub category." - }, - "reference-id": { - "type": "integer", - "format": "int32", - "description": "Reference ID is an identifier to match the detected entity to the index in the document" - }, - "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." - } - } - }, - "ExtractiveSummarizationLROTask": { - "type": "object", - "description": "An object representing the task definition for an Extractive Summarization task.", - "properties": { - "parameters": { - "$ref": "#/definitions/ExtractiveSummarizationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeDocumentsLROTask" - } - ], - "x-ms-discriminator-value": "ExtractiveSummarization" - }, - "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" - } - ] - }, - "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" - } - } - }, - "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." - } - } - }, - "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/AnalyzeDocumentsLROTask" - } - ], - "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" - } - ] - }, - "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" - } - } - }, - "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" - ] - }, - "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": [ - "!", - "#", - "$", - "%", - "&", - "*", - "+", - "-", - "=", - "?", - "@", - "^", - "_", - "~" - ] - }, - "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 - } - } - }, - "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": "common.json#/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": { - "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/dev/cognitiveservices/data-plane/Language/analyzetext-authoring.json b/dev/cognitiveservices/data-plane/Language/analyzetext-authoring.json deleted file mode 100644 index 3f221562aef7..000000000000 --- a/dev/cognitiveservices/data-plane/Language/analyzetext-authoring.json +++ /dev/null @@ -1,3133 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Cognitive Language Service - Analyze Text Authoring", - "version": "2023-04-01", - "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" - } - }, - { - "$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}/: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}/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": "#/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": { - "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" - }, - "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" - } - }, - "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", - "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", - "hasSnapshot" - ], - "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" - }, - "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" - }, - "TextAnalysisAuthoringProjectKindQueryOptionalParameter": { - "in": "query", - "name": "projectKind", - "description": "The project kind, default value is CustomSingleLabelClassification.", - "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" - }, - "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/dev/cognitiveservices/data-plane/Language/analyzetext.json b/dev/cognitiveservices/data-plane/Language/analyzetext.json deleted file mode 100644 index 528bd0ea4ce6..000000000000 --- a/dev/cognitiveservices/data-plane/Language/analyzetext.json +++ /dev/null @@ -1,2882 +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.", - "version": "2023-04-01" - }, - "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": "#/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" - }, - "Successful Submit Abstractive Summarization Task": { - "$ref": "./examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.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" - }, - "Successful Get Abstractive Summarization Result": { - "$ref": "./examples/text/SuccessfulAbstractiveSummarizationTaskResult.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": "#/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", - "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": "#/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" - }, - "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" - } - ] - }, - "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": "common.json#/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": { - "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": "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" - } - } - }, - "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" - ] - }, - "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 - } - } - } - }, - "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": "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": "#/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": "#/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": "#/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 - }, - "KeyPhraseTaskParameters": { - "type": "object", - "description": "Supported parameters for a Key Phrase Extraction task.", - "allOf": [ - { - "$ref": "#/definitions/PreBuiltTaskParameters" - } - ] - }, - "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/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." - } - } - }, - "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": "#/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" - }, - "JobErrors": { - "properties": { - "errors": { - "items": { - "$ref": "common.json#/definitions/Error" - }, - "type": "array" - } - }, - "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" - }, - "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": "#/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" - } - } - }, - "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." - }, - "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" - } - } - }, - "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/AbstractiveSummaryDocumentResult" - } - } - }, - "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" - ] - }, - "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": { - "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/dev/cognitiveservices/data-plane/Language/common.json b/dev/cognitiveservices/data-plane/Language/common.json deleted file mode 100644 index 7f583cdb4d14..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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": "2023-04-01" - }, - "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" - }, - "DocumentError": { - "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 document." - }, - "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." - } - }, - "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/DocumentError" - } - }, - "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/dev/cognitiveservices/data-plane/Language/examples/SuccessfulAnalyzeTextJobsCancelRequest.json b/dev/cognitiveservices/data-plane/Language/examples/SuccessfulAnalyzeTextJobsCancelRequest.json deleted file mode 100644 index cab594cfd719..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/SuccessfulAnalyzeTextJobsCancelRequest.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-04-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json b/dev/cognitiveservices/data-plane/Language/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json deleted file mode 100644 index 5823008ae035..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json +++ /dev/null @@ -1,131 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json b/dev/cognitiveservices/data-plane/Language/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json deleted file mode 100644 index b01d275593b4..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/SuccessfulEntityLinkingRequest.json b/dev/cognitiveservices/data-plane/Language/examples/SuccessfulEntityLinkingRequest.json deleted file mode 100644 index 4c26cafd35d9..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/SuccessfulEntityLinkingRequest.json +++ /dev/null @@ -1,128 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/SuccessfulEntityRecognitionRequest.json b/dev/cognitiveservices/data-plane/Language/examples/SuccessfulEntityRecognitionRequest.json deleted file mode 100644 index 3c446c0e6d09..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/SuccessfulEntityRecognitionRequest.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/SuccessfulKeyPhraseExtractionRequest.json b/dev/cognitiveservices/data-plane/Language/examples/SuccessfulKeyPhraseExtractionRequest.json deleted file mode 100644 index 59098ab951ab..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/SuccessfulKeyPhraseExtractionRequest.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/SuccessfulLanguageDetectionRequest.json b/dev/cognitiveservices/data-plane/Language/examples/SuccessfulLanguageDetectionRequest.json deleted file mode 100644 index 3e96dca0095e..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/SuccessfulLanguageDetectionRequest.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/SuccessfulPiiEntityRecognitionRequest.json b/dev/cognitiveservices/data-plane/Language/examples/SuccessfulPiiEntityRecognitionRequest.json deleted file mode 100644 index db0fefd14d21..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/SuccessfulPiiEntityRecognitionRequest.json +++ /dev/null @@ -1,88 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/SuccessfulSentimentAnalysisRequest.json b/dev/cognitiveservices/data-plane/Language/examples/SuccessfulSentimentAnalysisRequest.json deleted file mode 100644 index 39c57ca40a75..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/SuccessfulSentimentAnalysisRequest.json +++ /dev/null @@ -1,148 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json deleted file mode 100644 index 88fb6767655e..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulCreateProject.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulCreateProject.json deleted file mode 100644 index 98007ecafe72..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json deleted file mode 100644 index 74ba10ef7f11..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json deleted file mode 100644 index 7aaeb03f6752..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "projectName": "EmailApp", - "trainedModelLabel": "model2" - }, - "responses": { - "204": {} - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json deleted file mode 100644 index 86397edb0efc..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulDeployProject.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulDeployProject.json deleted file mode 100644 index c115c10978e7..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulDeployProject.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "projectName": "EmailApp", - "deploymentName": "production", - "body": { - "trainedModelLabel": "29886710a2ae49259d62cffca977db66" - } - }, - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulExportProject.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulExportProject.json deleted file mode 100644 index 4c84fa0276a7..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulExportProject.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json deleted file mode 100644 index e90d172ebf9c..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json deleted file mode 100644 index 6129720003e3..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json deleted file mode 100644 index 8e3275eb0950..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json deleted file mode 100644 index 0554591835a2..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json deleted file mode 100644 index dc21261da3bb..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetModel.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetModel.json deleted file mode 100644 index 30d7b001de6a..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetModel.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json deleted file mode 100644 index 8dc4b6f88e33..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json +++ /dev/null @@ -1,284 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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=2023-04-01&top=2147483637&skip={maxpagesize}&maxpagesize={maxpagesize}" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json deleted file mode 100644 index 8fb25eb99c9c..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json +++ /dev/null @@ -1,526 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetProject.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetProject.json deleted file mode 100644 index 50b53ae6415a..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetProject.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json deleted file mode 100644 index 73c8d1cf0647..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json deleted file mode 100644 index ed6b0478cdd7..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json +++ /dev/null @@ -1,398 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json deleted file mode 100644 index 7e288d169478..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json +++ /dev/null @@ -1,98 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json deleted file mode 100644 index 06780f7fa92b..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "projectKind": "Conversation" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "trainingConfigVersion": "2022-05-01", - "modelExpirationDate": "2022-10-28" - } - ], - "nextLink": null - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json deleted file mode 100644 index 0aac88c8d145..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json deleted file mode 100644 index 5f28035def5e..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulImportProject.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulImportProject.json deleted file mode 100644 index 61d70d484c59..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulImportProject.json +++ /dev/null @@ -1,78 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulListDeployments.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulListDeployments.json deleted file mode 100644 index c968d5123219..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulListDeployments.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulListModels.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulListModels.json deleted file mode 100644 index 0a9e351e22bb..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulListModels.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulListProjects.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulListProjects.json deleted file mode 100644 index 8b52f2c1adce..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulListProjects.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01" - }, - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json deleted file mode 100644 index 5772f4670098..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json +++ /dev/null @@ -1,90 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json deleted file mode 100644 index 9409332d34df..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json deleted file mode 100644 index 5ac2aa6d1bea..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulTrainProject.json b/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulTrainProject.json deleted file mode 100644 index a86428a5b7ea..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzeconversations-authoring/SuccessfulTrainProject.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzedocuments/SuccessfulAnalyzeTextJobsCancelRequest.json b/dev/cognitiveservices/data-plane/Language/examples/analyzedocuments/SuccessfulAnalyzeTextJobsCancelRequest.json deleted file mode 100644 index 74a03a34a42a..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzedocuments/SuccessfulAnalyzeTextJobsCancelRequest.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-documents/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzedocuments/SuccessfulPiiTaskResult.json b/dev/cognitiveservices/data-plane/Language/examples/analyzedocuments/SuccessfulPiiTaskResult.json deleted file mode 100644 index e49738947858..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzedocuments/SuccessfulPiiTaskResult.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redact PII 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": "PiiEntityRecognitionLROResults", - "taskName": "PII Redaction Task 1", - "lastUpdateDateTime": "2020-10-01T15:01:03Z", - "status": "succeeded", - "results": { - "documents": [ - { - "source": { - "location": "https://myblob.blob.core.windows.net/Container/document.txt", - "kind": "AzureBlob" - }, - "target": [ - { - "location": "https://myblob.blob.core.windows.net/Container/0af5def0-5855-41b2-9e75-0a559fb6f545_PiiEntityRecognition_1_document.txt", - "kind": "AzureBlob" - }, - { - "location": "https://myblob.blob.core.windows.net/Container/0af5def0-5855-41b2-9e75-0a559fb6f545_PiiEntityRecognition_1.json", - "kind": "AzureBlob" - } - ], - "id": "1", - "warnings": [] - } - ], - "errors": [], - "modelVersion": "2023-09-01" - } - } - ] - } - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzedocuments/SuccessfulPiiTaskSubmit.json b/dev/cognitiveservices/data-plane/Language/examples/analyzedocuments/SuccessfulPiiTaskSubmit.json deleted file mode 100644 index 8223a8a81c3d..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzedocuments/SuccessfulPiiTaskSubmit.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redact PII Example", - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "source": { - "location": "https://myblob.blob.core.windows.net/Container/document.txt", - "kind": "AzureBlob", - "managedIdentityClientId": "edaa610c-d7e8-4ba2-823a-97d871d661fb" - }, - "target": { - "location": "https://myblob.blob.core.windows.net/Container", - "kind": "AzureBlob" - } - } - ] - }, - "tasks": [ - { - "kind": "PiiEntityRecognition", - "taskName": "Redact PII Task 1", - "parameters": { - "redactionCharacter": "-" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{endpoint}/language/analyze-documents/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json deleted file mode 100644 index ee22e9fba1c8..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulCreateProject.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulCreateProject.json deleted file mode 100644 index 0b7c0e4759e7..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json deleted file mode 100644 index c7fe78e935dd..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulDeleteModel.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulDeleteModel.json deleted file mode 100644 index 4878a4e330a9..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulDeleteModel.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "projectName": "LoanAgreements", - "trainedModelLabel": "model2" - }, - "responses": { - "204": {} - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulDeleteProject.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulDeleteProject.json deleted file mode 100644 index 16b875ec4cf8..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulDeleteProject.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulDeployProject.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulDeployProject.json deleted file mode 100644 index d89e23562201..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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": "2023-04-01", - "projectName": "LoanAgreements", - "deploymentName": "production", - "body": { - "trainedModelLabel": "29886710a2ae49259d62cffca977db66" - } - }, - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulExportProject.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulExportProject.json deleted file mode 100644 index 2b428b69c027..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulExportProject.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetDeployment.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetDeployment.json deleted file mode 100644 index aef1a2c13cc3..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetDeployment.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json deleted file mode 100644 index dc9ac893ae0f..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetExportStatus.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetExportStatus.json deleted file mode 100644 index 56d2c50919bd..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetExportStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetImportStatus.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetImportStatus.json deleted file mode 100644 index aeef476cdd97..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetImportStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetLoadSnapshotStatus.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetLoadSnapshotStatus.json deleted file mode 100644 index 5199596f42c2..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetLoadSnapshotStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetModel.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetModel.json deleted file mode 100644 index 94fffc44e6c1..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetModel.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json deleted file mode 100644 index a3b7e0e9c428..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json +++ /dev/null @@ -1,295 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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=2023-04-01&top=2147483645&skip={maxpagesize}&maxpagesize={maxpagesize}" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json deleted file mode 100644 index 69d74725e758..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json +++ /dev/null @@ -1,232 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetProject.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetProject.json deleted file mode 100644 index 3da80053e31e..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetProject.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json deleted file mode 100644 index 73c8d1cf0647..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json deleted file mode 100644 index 2cdfd865d82a..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json +++ /dev/null @@ -1,389 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01" - }, - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json deleted file mode 100644 index a60f9f0aade3..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "projectKind": "CustomEntityRecognition" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "trainingConfigVersion": "2022-05-01", - "modelExpirationDate": "2022-10-28" - } - ], - "nextLink": null - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json deleted file mode 100644 index eef03f34b045..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json deleted file mode 100644 index 671b192b1951..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulImportProject.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulImportProject.json deleted file mode 100644 index 1016782ada17..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulListDeployments.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulListDeployments.json deleted file mode 100644 index faf480e9b87a..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulListDeployments.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulListModels.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulListModels.json deleted file mode 100644 index 8186c3f3d174..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulListModels.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-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", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulListProjects.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulListProjects.json deleted file mode 100644 index 46244a7fb500..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulListProjects.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01" - }, - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json deleted file mode 100644 index e9bf0ff70296..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json +++ /dev/null @@ -1,87 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulLoadSnapshot.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulLoadSnapshot.json deleted file mode 100644 index f1cb63240640..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulLoadSnapshot.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulSwapDeployments.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulSwapDeployments.json deleted file mode 100644 index a4d4408b4bba..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulTrainProject.json b/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulTrainProject.json deleted file mode 100644 index ea8b27d1e04a..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/analyzetext-authoring/SuccessfulTrainProject.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulAnalyzeConversations.json b/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulAnalyzeConversations.json deleted file mode 100644 index bc8f8805bc81..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json b/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json deleted file mode 100644 index 875e1e807b15..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "participantId": "1", - "id": "1", - "modality": "text", - "language": "en-GB", - "text": "trains from London" - } - }, - "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/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json b/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json deleted file mode 100644 index f23d13781902..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json b/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json deleted file mode 100644 index 705087d1ddf6..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversations/jobs/{jobId}?api-version=2023-04-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSummarizationTaskResult.json b/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSummarizationTaskResult.json deleted file mode 100644 index 4f49bdcd04a8..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSummarizationTaskResult.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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": "latest" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json b/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json deleted file mode 100644 index fb4d61aacc88..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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": "latest" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json b/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json deleted file mode 100644 index 3f7e3e9682f5..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSummarySubmit.json b/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSummarySubmit.json deleted file mode 100644 index 00a71497cd67..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSummarySubmit.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/questionanswering/SuccessfulQueryKnowledgebases.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/SuccessfulQueryKnowledgebases.json deleted file mode 100644 index 35e2adf286f6..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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/dev/cognitiveservices/data-plane/Language/examples/questionanswering/SuccessfulQueryText.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/SuccessfulQueryText.json deleted file mode 100644 index 7470afc8ebe5..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulCreateProject.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulCreateProject.json deleted file mode 100644 index 0379fa212ca0..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulDeleteProject.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulDeleteProject.json deleted file mode 100644 index 5f383a7c5843..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulGetProject.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulGetProject.json deleted file mode 100644 index 6559ff5eecd7..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulGetQnas.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulGetQnas.json deleted file mode 100644 index a0c507000d46..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulGetSources.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulGetSources.json deleted file mode 100644 index 93151be618e3..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulGetSynonyms.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulGetSynonyms.json deleted file mode 100644 index 64179691eedc..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "alterations": [ - "qnamaker", - "qna maker" - ] - }, - { - "alterations": [ - "botframework", - "bot framework" - ] - } - ] - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json deleted file mode 100644 index b32ee372970f..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json deleted file mode 100644 index c3448c1ed6b6..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json deleted file mode 100644 index faade3721442..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json deleted file mode 100644 index f77706e436b3..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json deleted file mode 100644 index 8e1a7e2a6879..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "projectName": "proj1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "deploymentName": "production", - "lastDeployedDateTime": "2021-05-01T15:13:22Z" - } - ] - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json deleted file mode 100644 index d2313483f1d9..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json deleted file mode 100644 index bf9a702a74e4..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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-01" - } - }, - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json deleted file mode 100644 index 21e0c108fad1..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json deleted file mode 100644 index 63c63c1a641d..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01" - }, - "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/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json deleted file mode 100644 index 5171bc538ad9..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "projectName": "proj1", - "body": { - "records": [ - { - "userId": "user1", - "userQuestion": "hi", - "qnaId": 1 - }, - { - "userId": "user1", - "userQuestion": "hello", - "qnaId": 2 - } - ] - } - }, - "responses": { - "204": {} - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulUpdateQnas.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulUpdateQnas.json deleted file mode 100644 index d2ce3b89bbf0..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json deleted file mode 100644 index f77706e436b3..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulUpdateSources.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulUpdateSources.json deleted file mode 100644 index 04f0f445f180..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json deleted file mode 100644 index f77706e436b3..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "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/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json deleted file mode 100644 index ce35df49d490..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01", - "projectName": "proj1", - "body": { - "value": [ - { - "alterations": [ - "qnamaker", - "qna maker" - ] - }, - { - "alterations": [ - "botframework", - "bot framework" - ] - } - ] - } - }, - "responses": { - "204": {} - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/text/SuccessfulAbstractiveSummarizationTaskResult.json b/dev/cognitiveservices/data-plane/Language/examples/text/SuccessfulAbstractiveSummarizationTaskResult.json deleted file mode 100644 index aeda986c5b03..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/text/SuccessfulAbstractiveSummarizationTaskResult.json +++ /dev/null @@ -1,56 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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": "latest" - } - } - ] - } - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.json b/dev/cognitiveservices/data-plane/Language/examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.json deleted file mode 100644 index 1fec0f6e6ffd..000000000000 --- a/dev/cognitiveservices/data-plane/Language/examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-04-01", - "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-01" - } - } - } -} diff --git a/dev/cognitiveservices/data-plane/Language/questionanswering-authoring.json b/dev/cognitiveservices/data-plane/Language/questionanswering-authoring.json deleted file mode 100644 index 1345452cd8f2..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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": "2023-04-01" - }, - "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-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/dev/cognitiveservices/data-plane/Language/questionanswering.json b/dev/cognitiveservices/data-plane/Language/questionanswering.json deleted file mode 100644 index 4fd80da03469..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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-01" - }, - "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/dev/cognitiveservices/data-plane/Language/readme.csharp.md b/dev/cognitiveservices/data-plane/Language/readme.csharp.md deleted file mode 100644 index f0c6a178371a..000000000000 --- a/dev/cognitiveservices/data-plane/Language/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/dev/cognitiveservices/data-plane/Language/readme.md b/dev/cognitiveservices/data-plane/Language/readme.md deleted file mode 100644 index b0aa3455b3e3..000000000000 --- a/dev/cognitiveservices/data-plane/Language/readme.md +++ /dev/null @@ -1,49 +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-11-11-preview. - - - -```yaml -tag: release_2023-11-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-11-15-preview' -input-file: - - analyzedocuments.json - - 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 -``` diff --git a/eng/common/instructions/azsdk-tools/create-release-plan.instructions.md b/eng/common/instructions/azsdk-tools/create-release-plan.instructions.md index fa55d8edb0ff..6cf05521925b 100644 --- a/eng/common/instructions/azsdk-tools/create-release-plan.instructions.md +++ b/eng/common/instructions/azsdk-tools/create-release-plan.instructions.md @@ -1,5 +1,10 @@ +> **Important Note for LLM** +> Backend processes may use Azure DevOps work item data as needed. However, do **not** mention or display the work item link/URL, or any reference to Azure DevOps work item resources directly in conversation with the user. +> All manual updates to an existing release plan must be made through the [Release Planner Tool](https://aka.ms/sdk-release-planner) to ensure proper tracking and validation. +> Only provide release plan details such as **Release Plan Link** and **Release Plan ID** to the user + # Release Plan Creation Process -You goal is to create a valid release plan. You must prompt user to provide all required information and all input must match the format and requirement mentioned in step 3 below. +Your goal is to create a valid release plan. You must prompt user to provide all required information and all input must match the format and requirement mentioned in step 3 below. Follow these steps in order to create or manage a release plan for an API specification pull request: ## Step 1: Validate Prerequisites diff --git a/eng/common/instructions/azsdk-tools/typespec-docs.instructions.md b/eng/common/instructions/azsdk-tools/typespec-docs.instructions.md new file mode 100644 index 000000000000..314555691f74 --- /dev/null +++ b/eng/common/instructions/azsdk-tools/typespec-docs.instructions.md @@ -0,0 +1,11 @@ +Your goal is to provide the most up-to-date documentation on the TypeSpec language, core libraries, and writing Azure services and clients in TypeSpec. Whenever a user asks a question about how something should be written in TypeSpec, you should use the documentation links below to pinpoint the most relevant and accurate information. + +## TypeSpec Azure + +- https://azure.github.io/typespec-azure/docs/llms.txt contains an index of up-to-date documentation for TypeSpec Azure libraries, including how to write service specifications for Azure Resource Manager (ARM) and Azure Data Plane services, as well as how to customize generated clients. +- Always refer to https://azure.github.io/typespec-azure/docs/llms.txt when a user asks TypeSpec related questions in case there is existing documentation that can help answer them. This also applies when a user asks to make changes to TypeSpec specifications. + +## TypeSpec documentation + +- https://typespec.io/docs/llms.txt contains an index of up-to-date documentation for TypeSpec language basics and core libraries, including how concepts like visibility and versioning work. +- Always refer to https://typespec.io/docs/llms.txt when a user asks TypeSpec related questions that aren't covered by the TypeSpec Azure topics. diff --git a/eng/common/scripts/Prepare-Release.ps1 b/eng/common/scripts/Prepare-Release.ps1 old mode 100644 new mode 100755 index e82c5982ac96..b3990671deea --- a/eng/common/scripts/Prepare-Release.ps1 +++ b/eng/common/scripts/Prepare-Release.ps1 @@ -1,3 +1,5 @@ +#!/usr/bin/env pwsh + #Requires -Version 6.0 <# diff --git a/eng/tools/lint-diff/package.json b/eng/tools/lint-diff/package.json index a5e657d8b48a..4ccc8357ac3f 100644 --- a/eng/tools/lint-diff/package.json +++ b/eng/tools/lint-diff/package.json @@ -19,16 +19,16 @@ "node": ">= 20.0.0" }, "dependencies": { - "@apidevtools/json-schema-ref-parser": "^14.1.1", + "@apidevtools/json-schema-ref-parser": "^14.2.1", "@azure-tools/specs-shared": "file:../../../.github/shared", "@microsoft.azure/openapi-validator": "2.2.4", - "@microsoft.azure/openapi-validator-core": "1.0.6", - "@microsoft.azure/openapi-validator-rulesets": "2.1.9", + "@microsoft.azure/openapi-validator-core": "1.0.7", + "@microsoft.azure/openapi-validator-rulesets": "2.1.10", "autorest": "^3.7.2", "axios": "^1.8.3", "change-case": "^5.4.4", "deep-eql": "^5.0.2", - "marked": "^16.1.1" + "marked": "^16.3.0" }, "devDependencies": { "@types/deep-eql": "^4.0.2", diff --git a/eng/tools/oav-runner/package.json b/eng/tools/oav-runner/package.json index 6ab2c45bb452..d3f78bc1fad6 100644 --- a/eng/tools/oav-runner/package.json +++ b/eng/tools/oav-runner/package.json @@ -17,7 +17,7 @@ "dependencies": { "@azure-tools/specs-shared": "file:../../../.github/shared", "js-yaml": "^4.1.0", - "oav": "^4.0.0", + "oav": "4.0.0", "simple-git": "^3.27.0" }, "devDependencies": { diff --git a/eng/tools/sdk-suppressions/package.json b/eng/tools/sdk-suppressions/package.json index e54eff101a35..000b30e44283 100644 --- a/eng/tools/sdk-suppressions/package.json +++ b/eng/tools/sdk-suppressions/package.json @@ -21,7 +21,7 @@ "dependencies": { "@azure-tools/specs-shared": "file:../../../.github/shared", "ajv": "^8.17.1", - "debug": "^4.4.0", + "debug": "^4.4.3", "lodash": "^4.17.20", "simple-git": "^3.27.0", "yaml": "^2.4.2" diff --git a/eng/tools/spec-gen-sdk-runner/package.json b/eng/tools/spec-gen-sdk-runner/package.json index 1ac2d416458a..3a8031049bbe 100644 --- a/eng/tools/spec-gen-sdk-runner/package.json +++ b/eng/tools/spec-gen-sdk-runner/package.json @@ -26,7 +26,7 @@ "@types/node": "^20.0.0", "@vitest/coverage-v8": "^3.1.2", "eslint": "^9.21.0", - "eslint-plugin-unicorn": "^60.0.0", + "eslint-plugin-unicorn": "^61.0.2", "prettier": "~3.6.2", "prettier-plugin-organize-imports": "^4.2.0", "typescript": "~5.8.2", diff --git a/eng/tools/suppressions/package.json b/eng/tools/suppressions/package.json index 5d3f0f152b25..11daae97cad3 100644 --- a/eng/tools/suppressions/package.json +++ b/eng/tools/suppressions/package.json @@ -20,7 +20,7 @@ "dependencies": { "minimatch": "^10.0.1", "yaml": "^2.4.2", - "zod": "^4.0.2" + "zod": "^4.1.8" }, "devDependencies": { "@types/node": "^20.0.0", diff --git a/eng/tools/typespec-validation/package.json b/eng/tools/typespec-validation/package.json index be9b9e24d606..725b3bc0e36d 100644 --- a/eng/tools/typespec-validation/package.json +++ b/eng/tools/typespec-validation/package.json @@ -8,7 +8,7 @@ }, "dependencies": { "@azure-tools/specs-shared": "file:../../../.github/shared", - "debug": "^4.4.0", + "debug": "^4.4.3", "globby": "^14.0.1", "picocolors": "^1.1.1", "simple-git": "^3.24.0", diff --git a/eng/tools/typespec-validation/src/rules/sdk-tspconfig-validation.ts b/eng/tools/typespec-validation/src/rules/sdk-tspconfig-validation.ts index c337cc30fd68..942e64bfe066 100644 --- a/eng/tools/typespec-validation/src/rules/sdk-tspconfig-validation.ts +++ b/eng/tools/typespec-validation/src/rules/sdk-tspconfig-validation.ts @@ -340,43 +340,76 @@ export class TspConfigTsMlcDpPackageNameMatchPatternSubRule extends TspconfigEmi return skipForRestLevelClientOrManagementPlaneInTsEmitter(config, folder); } } -// ----- Go data plane sub rules ----- -export class TspConfigGoDpServiceDirMatchPatternSubRule extends TspconfigEmitterOptionsSubRuleBase { + +// ----- Go common sub rules ----- +export class TspConfigGoModuleMatchPatternSubRule extends TspconfigEmitterOptionsSubRuleBase { constructor() { - super("@azure-tools/typespec-go", "service-dir", new RegExp(/^sdk\/.*$/)); + super( + "@azure-tools/typespec-go", + "module", + new RegExp(/^github.com\/Azure\/azure-sdk-for-go\/.*$/), + ); } - protected skip(_: any, folder: string) { - return skipForManagementPlane(folder); + protected validate(config: any): RuleResult { + const module = config?.options?.[this.emitterName]?.["module"]; + const containingModule = config?.options?.[this.emitterName]?.["containing-module"]; + if (module === undefined && containingModule === undefined) return { success: false }; + if (module === undefined) return { success: true }; + return super.validate(config); + } +} + +export class TspConfigGoContainingModuleMatchPatternSubRule extends TspconfigEmitterOptionsSubRuleBase { + constructor() { + super( + "@azure-tools/typespec-go", + "containing-module", + new RegExp(/^github.com\/Azure\/azure-sdk-for-go\/.*$/), + ); + } + protected validate(config: any): RuleResult { + const module = config?.options?.[this.emitterName]?.["module"]; + const containingModule = config?.options?.[this.emitterName]?.["containing-module"]; + if (module === undefined && containingModule === undefined) return { success: false }; + if (containingModule === undefined) return { success: true }; + return super.validate(config); } } -export class TspConfigGoDpPackageDirectoryMatchPatternSubRule extends TspconfigEmitterOptionsSubRuleBase { +// ----- Go data plane sub rules ----- +export class TspConfigGoDpServiceDirMatchPatternSubRule extends TspconfigEmitterOptionsSubRuleBase { constructor() { - super("@azure-tools/typespec-go", "package-dir", new RegExp(/^az.*$/)); + super("@azure-tools/typespec-go", "service-dir", new RegExp(/^(\{output-dir\}\/)?sdk\/.*$/)); } protected skip(_: any, folder: string) { return skipForManagementPlane(folder); } + protected validate(config: any): RuleResult { + let serviceDir = config?.options?.[this.emitterName]?.["service-dir"]; + if (serviceDir === undefined) return { success: true }; + return super.validate(config); + } } -export class TspConfigGoDpModuleMatchPatternSubRule extends TspconfigEmitterOptionsSubRuleBase { +export class TspConfigGoDpEmitterOutputDirMatchPatternSubRule extends TspconfigEmitterOptionsSubRuleBase { constructor() { super( "@azure-tools/typespec-go", - "module", - new RegExp(/^github.com\/Azure\/azure-sdk-for-go\/.*$/), + "emitter-output-dir", + new RegExp(/^(\{output-dir\}\/)?(\{service-dir\}|sdk\/).*\/az.*/), ); } - protected validate(config: any): RuleResult { - let module = config?.options?.[this.emitterName]?.module; - if (module === undefined) return { success: true }; - return super.validate(config); - } protected skip(_: any, folder: string) { return skipForManagementPlane(folder); } } +export class TspConfigGoAzInjectSpansTrueSubRule extends TspconfigEmitterOptionsSubRuleBase { + constructor() { + super("@azure-tools/typespec-go", "inject-spans", true); + } +} + // ----- Go Mgmt plane sub rules ----- export class TspConfigGoMgmtServiceDirMatchPatternSubRule extends TspconfigEmitterOptionsSubRuleBase { constructor() { @@ -389,23 +422,19 @@ export class TspConfigGoMgmtServiceDirMatchPatternSubRule extends TspconfigEmitt protected skip(_: any, folder: string) { return skipForDataPlane(folder); } -} - -export class TspConfigGoMgmtPackageDirectorySubRule extends TspconfigEmitterOptionsSubRuleBase { - constructor() { - super("@azure-tools/typespec-go", "package-dir", new RegExp(/^arm[^\/]*$/)); - } - protected skip(_: any, folder: string) { - return skipForDataPlane(folder); + protected validate(config: any): RuleResult { + let serviceDir = config?.options?.[this.emitterName]?.["service-dir"]; + if (serviceDir === undefined) return { success: true }; + return super.validate(config); } } -export class TspConfigGoMgmtModuleEqualStringSubRule extends TspconfigEmitterOptionsSubRuleBase { +export class TspConfigGoMgmtEmitterOutputDirMatchPatternSubRule extends TspconfigEmitterOptionsSubRuleBase { constructor() { super( "@azure-tools/typespec-go", - "module", - "github.com/Azure/azure-sdk-for-go/{service-dir}/{package-dir}", + "emitter-output-dir", + new RegExp(/^(\{output-dir\}\/)?(\{service-dir\}|sdk\/resourcemanager\/)[^\/]*\/arm.*/), ); } protected skip(_: any, folder: string) { @@ -440,14 +469,6 @@ export class TspConfigGoMgmtGenerateFakesTrueSubRule extends TspconfigEmitterOpt } } -// ----- Go az sub rules ----- - -export class TspConfigGoAzInjectSpansTrueSubRule extends TspconfigEmitterOptionsSubRuleBase { - constructor() { - super("@azure-tools/typespec-go", "inject-spans", true); - } -} - // ----- Python management plane sub rules ----- export class TspConfigPythonMgmtPackageDirectorySubRule extends TspconfigEmitterOptionsSubRuleBase { constructor() { @@ -529,15 +550,15 @@ export const defaultRules = [ new TspConfigTsRlcDpPackageNameMatchPatternSubRule(), new TspConfigTsMlcDpPackageNameMatchPatternSubRule(), new TspConfigGoMgmtServiceDirMatchPatternSubRule(), - new TspConfigGoMgmtPackageDirectorySubRule(), - new TspConfigGoMgmtModuleEqualStringSubRule(), + new TspConfigGoMgmtEmitterOutputDirMatchPatternSubRule(), new TspConfigGoMgmtGenerateSamplesTrueSubRule(), new TspConfigGoMgmtGenerateFakesTrueSubRule(), new TspConfigGoMgmtHeadAsBooleanTrueSubRule(), new TspConfigGoAzInjectSpansTrueSubRule(), new TspConfigGoDpServiceDirMatchPatternSubRule(), - new TspConfigGoDpPackageDirectoryMatchPatternSubRule(), - new TspConfigGoDpModuleMatchPatternSubRule(), + new TspConfigGoDpEmitterOutputDirMatchPatternSubRule(), + new TspConfigGoModuleMatchPatternSubRule(), + new TspConfigGoContainingModuleMatchPatternSubRule(), new TspConfigPythonMgmtPackageDirectorySubRule(), new TspConfigPythonMgmtNamespaceSubRule(), new TspConfigPythonDpPackageDirectorySubRule(), diff --git a/eng/tools/typespec-validation/test/sdk-tspconfig-validation.test.ts b/eng/tools/typespec-validation/test/sdk-tspconfig-validation.test.ts index 6643ccd3d784..84e5b14678c8 100644 --- a/eng/tools/typespec-validation/test/sdk-tspconfig-validation.test.ts +++ b/eng/tools/typespec-validation/test/sdk-tspconfig-validation.test.ts @@ -11,15 +11,15 @@ import { TspConfigCsharpAzNamespaceSubRule, TspConfigCsharpMgmtNamespaceSubRule, TspConfigGoAzInjectSpansTrueSubRule, - TspConfigGoDpModuleMatchPatternSubRule, - TspConfigGoDpPackageDirectoryMatchPatternSubRule, + TspConfigGoContainingModuleMatchPatternSubRule, + TspConfigGoDpEmitterOutputDirMatchPatternSubRule, TspConfigGoDpServiceDirMatchPatternSubRule, + TspConfigGoMgmtEmitterOutputDirMatchPatternSubRule, TspConfigGoMgmtGenerateFakesTrueSubRule, TspConfigGoMgmtGenerateSamplesTrueSubRule, TspConfigGoMgmtHeadAsBooleanTrueSubRule, - TspConfigGoMgmtModuleEqualStringSubRule, - TspConfigGoMgmtPackageDirectorySubRule, TspConfigGoMgmtServiceDirMatchPatternSubRule, + TspConfigGoModuleMatchPatternSubRule, TspConfigJavaAzEmitterOutputDirMatchPatternSubRule, TspConfigJavaMgmtEmitterOutputDirMatchPatternSubRule, TspConfigJavaMgmtNamespaceFormatSubRule, @@ -274,24 +274,36 @@ const goManagementServiceDirTestCases = createEmitterOptionTestCases( "sdk/resourcemanager/aaa", "sdk/manager/aaa", [new TspConfigGoMgmtServiceDirMatchPatternSubRule()], + true, ); -const goManagementPackageDirTestCases = createEmitterOptionTestCases( +const goManagementEmitterOutputDirTestCases = createEmitterOptionTestCases( "@azure-tools/typespec-go", managementTspconfigFolder, - "package-dir", - "armaaa", - "aaa", - [new TspConfigGoMgmtPackageDirectorySubRule()], + "emitter-output-dir", + "{output-dir}/sdk/resourcemanager/compute/armcompute", + "{output-dir}/sdk/messaging/eventgrid/azsystemevents", + [new TspConfigGoMgmtEmitterOutputDirMatchPatternSubRule()], ); const goManagementModuleTestCases = createEmitterOptionTestCases( "@azure-tools/typespec-go", managementTspconfigFolder, "module", - "github.com/Azure/azure-sdk-for-go/{service-dir}/{package-dir}", - "github.com/Azure/azure-sdk-for-java/{service-dir}/{package-dir}", - [new TspConfigGoMgmtModuleEqualStringSubRule()], + "github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute", + "github.com/Azure/azure-sdk-for-java/sdk/compute/arm-compute", + [new TspConfigGoModuleMatchPatternSubRule()], + false, +); + +const goManagementContainingModuleTestCases = createEmitterOptionTestCases( + "@azure-tools/typespec-go", + managementTspconfigFolder, + "containing-module", + "github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute", + "github.com/Azure/azure-sdk-for-java/sdk/compute/arm-compute", + [new TspConfigGoContainingModuleMatchPatternSubRule()], + false, ); const goManagementGenerateExamplesTestCases = createEmitterOptionTestCases( @@ -343,19 +355,29 @@ const goDpModuleTestCases = createEmitterOptionTestCases( "@azure-tools/typespec-go", "", "module", - "github.com/Azure/azure-sdk-for-go/aaa", + "github.com/Azure/azure-sdk-for-go/sdk/messaging/aaa", "github.com/Azure/azure-sdk-for-cpp/bbb", - [new TspConfigGoDpModuleMatchPatternSubRule()], - true, + [new TspConfigGoModuleMatchPatternSubRule()], + false, ); -const goDpPackageDirTestCases = createEmitterOptionTestCases( +const goDpContainingModuleTestCases = createEmitterOptionTestCases( "@azure-tools/typespec-go", "", - "package-dir", - "az1/2/3", - "bzasd", - [new TspConfigGoDpPackageDirectoryMatchPatternSubRule()], + "containing-module", + "github.com/Azure/azure-sdk-for-go/sdk/messaging/aaa", + "github.com/Azure/azure-sdk-for-cpp/bbb", + [new TspConfigGoContainingModuleMatchPatternSubRule()], + false, +); + +const goDpEmitterOutputDirTestCases = createEmitterOptionTestCases( + "@azure-tools/typespec-go", + "", + "emitter-output-dir", + "{output-dir}/sdk/messaging/eventgrid/azsystemevents", + "{output-dir}/sdk/resourcemanager/compute/armcompute", + [new TspConfigGoDpEmitterOutputDirMatchPatternSubRule()], ); const goDpServiceDirTestCases = createEmitterOptionTestCases( @@ -365,6 +387,7 @@ const goDpServiceDirTestCases = createEmitterOptionTestCases( "sdk/2/3", "sd/k", [new TspConfigGoDpServiceDirMatchPatternSubRule()], + true, ); const javaAzEmitterOutputDirTestCases = createEmitterOptionTestCases( @@ -572,15 +595,14 @@ options: description: "Suppress option with wildcard at the end", folder: managementTspconfigFolder, subRules: [ - new TspConfigGoMgmtPackageDirectorySubRule(), - new TspConfigGoMgmtModuleEqualStringSubRule(), + new TspConfigGoMgmtEmitterOutputDirMatchPatternSubRule(), + new TspConfigGoModuleMatchPatternSubRule(), ], tspconfigContent: ` options: "@azure-tools/typespec-go": package-dir: "wrong/directory" - module-name: "invalid-module" - generate-consts: false + module: "invalid-module" `, success: true, ignoredKeyPaths: ["options.@azure-tools/typespec-go.*"], @@ -614,15 +636,17 @@ describe("tspconfig", function () { ...tsDpModularPackageNameTestCases, // go ...goManagementServiceDirTestCases, - ...goManagementPackageDirTestCases, + ...goManagementEmitterOutputDirTestCases, ...goManagementModuleTestCases, + ...goManagementContainingModuleTestCases, ...goManagementGenerateExamplesTestCases, ...goManagementGenerateFakesTestCases, ...goManagementHeadAsBooleanTestCases, ...goManagementInjectSpansTestCases, ...goDpInjectSpansTestCases, ...goDpModuleTestCases, - ...goDpPackageDirTestCases, + ...goDpContainingModuleTestCases, + ...goDpEmitterOutputDirTestCases, ...goDpServiceDirTestCases, // java ...javaAzEmitterOutputDirTestCases, diff --git a/package-lock.json b/package-lock.json index 09ad21794f73..8e1e2fae8a7b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6,7 +6,7 @@ "": { "name": "azure-rest-api-specs", "devDependencies": { - "@autorest/openapi-to-typespec": "0.11.9", + "@autorest/openapi-to-typespec": "0.11.10", "@azure-tools/spec-gen-sdk": "~0.9.1", "@azure-tools/specs-shared": "file:.github/shared", "@azure-tools/typespec-apiview": "0.7.2", @@ -16,9 +16,10 @@ "@azure-tools/typespec-azure-resource-manager": "0.60.0", "@azure-tools/typespec-azure-rulesets": "0.60.0", "@azure-tools/typespec-client-generator-cli": "0.28.1", - "@azure-tools/typespec-client-generator-core": "0.60.0", + "@azure-tools/typespec-client-generator-core": "0.60.1", "@azure-tools/typespec-liftr-base": "0.8.0", - "@azure/avocado": "^0.9.1", + "@azure/avocado": "0.9.3", + "@azure/oad": "0.12.0", "@microsoft.azure/openapi-validator": "2.2.4", "@microsoft.azure/openapi-validator-core": "1.0.6", "@microsoft.azure/openapi-validator-rulesets": "2.1.7", @@ -34,7 +35,7 @@ "@typespec/versioning": "0.74.0", "@typespec/xml": "0.74.0", "azure-rest-api-specs-eng-tools": "file:eng/tools", - "oav": "^4.0.0", + "oav": "4.0.0", "prettier": "~3.6.2", "typescript": "~5.8.2" }, @@ -47,10 +48,10 @@ "name": "@azure-tools/specs-shared", "dev": true, "dependencies": { - "@apidevtools/json-schema-ref-parser": "^14.1.1", - "debug": "^4.4.0", + "@apidevtools/json-schema-ref-parser": "^14.2.1", + "debug": "^4.4.3", "js-yaml": "^4.1.0", - "marked": "^16.1.1", + "marked": "^16.3.0", "simple-git": "^3.27.0" }, "bin": { @@ -73,10 +74,47 @@ "vitest": "^3.1.2" } }, + ".github/shared/node_modules/@apidevtools/json-schema-ref-parser": { + "version": "14.2.1", + "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-14.2.1.tgz", + "integrity": "sha512-HmdFw9CDYqM6B25pqGBpNeLCKvGPlIx1EbLrVL0zPvj50CJQUHyBNBw45Muk0kEIkogo1VZvOKHajdMuAzSxRg==", + "dev": true, + "license": "MIT", + "dependencies": { + "js-yaml": "^4.1.0" + }, + "engines": { + "node": ">= 20" + }, + "funding": { + "url": "https://github.com/sponsors/philsturgeon" + }, + "peerDependencies": { + "@types/json-schema": "^7.0.15" + } + }, + ".github/shared/node_modules/debug": { + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.3" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, ".github/shared/node_modules/marked": { - "version": "16.2.0", - "resolved": "https://registry.npmjs.org/marked/-/marked-16.2.0.tgz", - "integrity": "sha512-LbbTuye+0dWRz2TS9KJ7wsnD4KAtpj0MVkWc90XvBa6AslXsT0hTBVH5k32pcSyHH1fst9XEFJunXHktVy0zlg==", + "version": "16.3.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-16.3.0.tgz", + "integrity": "sha512-K3UxuKu6l6bmA5FUwYho8CfJBlsUWAooKtdGgMcERSpF7gcBUrCGsLH7wDaaNOzwq18JzSUDyoEb/YsrqMac3w==", "dev": true, "license": "MIT", "bin": { @@ -108,16 +146,16 @@ "name": "@azure-tools/lint-diff", "dev": true, "dependencies": { - "@apidevtools/json-schema-ref-parser": "^14.1.1", + "@apidevtools/json-schema-ref-parser": "^14.2.1", "@azure-tools/specs-shared": "file:../../../.github/shared", "@microsoft.azure/openapi-validator": "2.2.4", - "@microsoft.azure/openapi-validator-core": "1.0.6", - "@microsoft.azure/openapi-validator-rulesets": "2.1.9", + "@microsoft.azure/openapi-validator-core": "1.0.7", + "@microsoft.azure/openapi-validator-rulesets": "2.1.10", "autorest": "^3.7.2", "axios": "^1.8.3", "change-case": "^5.4.4", "deep-eql": "^5.0.2", - "marked": "^16.1.1" + "marked": "^16.3.0" }, "bin": { "lint-diff": "cmd/lint-diff.js" @@ -147,217 +185,44 @@ "undici-types": "~5.26.4" } }, - "eng/tools/node_modules/@azure/oad": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/@azure/oad/-/oad-0.12.0.tgz", - "integrity": "sha512-o7JURA54DgTk0DXDjJuWMUtHBo9Qbhz/OR0Dw+QYwnPzEwdqjWhoe7WBlvtrGu5JhRnjLDfbTA4te0rkWkiwBw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@ts-common/fs": "^0.2.0", - "@ts-common/iterator": "^0.3.6", - "@ts-common/json": "^0.3.1", - "@ts-common/json-parser": "^0.9.0", - "@ts-common/source-map": "^0.5.0", - "@ts-common/string-map": "^0.3.0", - "acorn": "^5.7.4", - "autorest": "^3.6.1", - "glob": "^7.1.3", - "js-yaml": "^3.13.1", - "json-pointer": "^0.6.2", - "json-refs": "^3.0.15", - "kind-of": "^6.0.3", - "lodash": "^4.17.21", - "minimist": "^1.2.8", - "set-value": "^4.1.0", - "source-map": "^0.7.4", - "tslib": "^2.6.3", - "winston": "^3.13.0", - "yargs": "^13.2.2", - "yargs-parser": "^13.1.2" - }, - "bin": { - "oad": "dist/cli.js" - }, - "engines": { - "node": ">=20.0.0" - } - }, - "eng/tools/node_modules/@azure/oad/node_modules/ansi-regex": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.1.tgz", - "integrity": "sha512-ILlv4k/3f6vfQ4OoP2AGvirOktlQ98ZEL1k9FaQjxa3L1abBgbuTDAdPOpvbGncC0BTVQrl+OM8xZGK6tWXt7g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "eng/tools/node_modules/@azure/oad/node_modules/ansi-styles": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", - "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "eng/tools/node_modules/@apidevtools/json-schema-ref-parser": { + "version": "14.2.1", + "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-14.2.1.tgz", + "integrity": "sha512-HmdFw9CDYqM6B25pqGBpNeLCKvGPlIx1EbLrVL0zPvj50CJQUHyBNBw45Muk0kEIkogo1VZvOKHajdMuAzSxRg==", "dev": true, "license": "MIT", "dependencies": { - "color-convert": "^1.9.0" - }, - "engines": { - "node": ">=4" - } - }, - "eng/tools/node_modules/@azure/oad/node_modules/cliui": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/cliui/-/cliui-5.0.0.tgz", - "integrity": "sha512-PYeGSEmmHM6zvoef2w8TPzlrnNpXIjTipYK780YswmIP9vjxmd6Y2a3CB2Ks6/AU8NHjZugXvo8w3oWM2qnwXA==", - "dev": true, - "license": "ISC", - "dependencies": { - "string-width": "^3.1.0", - "strip-ansi": "^5.2.0", - "wrap-ansi": "^5.1.0" - } - }, - "eng/tools/node_modules/@azure/oad/node_modules/emoji-regex": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", - "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", - "dev": true, - "license": "MIT" - }, - "eng/tools/node_modules/@azure/oad/node_modules/glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", - "dev": true, - "license": "ISC", - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" + "js-yaml": "^4.1.0" }, "engines": { - "node": "*" + "node": ">= 20" }, "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "eng/tools/node_modules/@azure/oad/node_modules/js-yaml": { - "version": "3.14.1", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", - "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==", - "dev": true, - "license": "MIT", - "dependencies": { - "argparse": "^1.0.7", - "esprima": "^4.0.0" - }, - "bin": { - "js-yaml": "bin/js-yaml.js" - } - }, - "eng/tools/node_modules/@azure/oad/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, - "eng/tools/node_modules/@azure/oad/node_modules/string-width": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", - "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", - "dev": true, - "license": "MIT", - "dependencies": { - "emoji-regex": "^7.0.1", - "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^5.1.0" - }, - "engines": { - "node": ">=6" - } - }, - "eng/tools/node_modules/@azure/oad/node_modules/strip-ansi": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", - "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-regex": "^4.1.0" - }, - "engines": { - "node": ">=6" - } - }, - "eng/tools/node_modules/@azure/oad/node_modules/wrap-ansi": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-5.1.0.tgz", - "integrity": "sha512-QC1/iN/2/RPVJ5jYK8BGttj5z83LmSKmvbvrXPNCLZSEb32KKVDJDl/MOt2N01qU2H/FkzEa9PKto1BqDjtd7Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-styles": "^3.2.0", - "string-width": "^3.0.0", - "strip-ansi": "^5.0.0" + "url": "https://github.com/sponsors/philsturgeon" }, - "engines": { - "node": ">=6" + "peerDependencies": { + "@types/json-schema": "^7.0.15" } }, - "eng/tools/node_modules/@azure/oad/node_modules/y18n": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.3.tgz", - "integrity": "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==", - "dev": true, - "license": "ISC" - }, - "eng/tools/node_modules/@azure/oad/node_modules/yargs": { - "version": "13.3.2", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-13.3.2.tgz", - "integrity": "sha512-AX3Zw5iPruN5ie6xGRIDgqkT+ZhnRlZMLMHAs8tg7nRruy2Nb+i5o9bwghAogtM08q1dpr2LVoS8KSTMYpWXUw==", + "eng/tools/node_modules/@microsoft.azure/openapi-validator-core": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/@microsoft.azure/openapi-validator-core/-/openapi-validator-core-1.0.7.tgz", + "integrity": "sha512-7hSz1571z2Efx86AnXCuV7jEKw88lKhBWHBdThPBvdGsEEkNTNvXnGMdae/eNRO9a//gqowQPuD0A5oQWimFwQ==", "dev": true, "license": "MIT", "dependencies": { - "cliui": "^5.0.0", - "find-up": "^3.0.0", - "get-caller-file": "^2.0.1", - "require-directory": "^2.1.1", - "require-main-filename": "^2.0.0", - "set-blocking": "^2.0.0", - "string-width": "^3.0.0", - "which-module": "^2.0.0", - "y18n": "^4.0.0", - "yargs-parser": "^13.1.2" - } - }, - "eng/tools/node_modules/@azure/oad/node_modules/yargs-parser": { - "version": "13.1.2", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-13.1.2.tgz", - "integrity": "sha512-3lbsNRf/j+A4QuSZfDRA7HRSfWrzO0YjqTJd5kjAq37Zep1CEgaYmrH9Q3GwPiB9cHyd1Y1UwggGhJGoxipbzg==", - "dev": true, - "license": "ISC", - "dependencies": { - "camelcase": "^5.0.0", - "decamelize": "^1.2.0" + "@azure-tools/uri": "^3.1.1", + "dependency-graph": "^1.0.0", + "jsonc-parser": "^3.2.1", + "jsonpath-plus": "^10.3.0", + "lodash": "^4.17.21", + "tslib": "^2.3.1" } }, "eng/tools/node_modules/@microsoft.azure/openapi-validator-rulesets": { - "version": "2.1.9", - "resolved": "https://registry.npmjs.org/@microsoft.azure/openapi-validator-rulesets/-/openapi-validator-rulesets-2.1.9.tgz", - "integrity": "sha512-sn3y0BNTFoH5HwrY7U6l5u1xolLenyc0vWkM1TvDcHlyTJ6ef5MJ42Cu07t/i4H1OIkR6C8v3opxan1FqgO3gg==", + "version": "2.1.10", + "resolved": "https://registry.npmjs.org/@microsoft.azure/openapi-validator-rulesets/-/openapi-validator-rulesets-2.1.10.tgz", + "integrity": "sha512-UHqIesjLwHG7eIs6HyUv6sGRkUvwtO9Wv5r7U2Se7UeKw/Q6HF40TKc6CNNkd1YBKRXXoZivlAzQhHyC2Te1rA==", "dev": true, "license": "MIT", "dependencies": { @@ -368,7 +233,7 @@ "@stoplight/spectral-formats": "^1.6.0", "@stoplight/spectral-functions": "^1.7.2", "@stoplight/types": "^14.1.1", - "jsonpath-plus": "^8.1.0", + "jsonpath-plus": "^10.3.0", "lodash": "^4.17.21", "string.prototype.matchall": "^4.0.11", "tslib": "^2.3.1" @@ -390,26 +255,6 @@ "js-yaml": "^4.1.0" } }, - "eng/tools/node_modules/@ts-common/iterator": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", - "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", - "dev": true, - "license": "Apache-2.0" - }, - "eng/tools/node_modules/acorn": { - "version": "5.7.4", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-5.7.4.tgz", - "integrity": "sha512-1D++VG7BhrtvQpNbBzovKNc1FLGGEE/oGe7b9xJm/RFHMBeUaUGpluV9RLjZa47YFdPcDAenEYuq9pQPcMdLJg==", - "dev": true, - "license": "MIT", - "bin": { - "acorn": "bin/acorn" - }, - "engines": { - "node": ">=0.4.0" - } - }, "eng/tools/node_modules/ajv": { "version": "8.17.1", "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", @@ -453,16 +298,6 @@ "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, - "eng/tools/node_modules/argparse": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", - "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", - "dev": true, - "license": "MIT", - "dependencies": { - "sprintf-js": "~1.0.2" - } - }, "eng/tools/node_modules/cliui": { "version": "9.0.1", "resolved": "https://registry.npmjs.org/cliui/-/cliui-9.0.1.tgz", @@ -496,13 +331,31 @@ "node": "*" } }, - "eng/tools/node_modules/emoji-regex": { - "version": "10.4.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.4.0.tgz", - "integrity": "sha512-EC+0oUMY1Rqm4O6LLrgjtYDvcVYTy7chDnM4Q7030tP4Kwj3u/pR6gP9ygnp2CJMK5Gq+9Q2oqmrFJAz01DXjw==", + "eng/tools/node_modules/debug": { + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", "dev": true, - "license": "MIT" - }, + "license": "MIT", + "dependencies": { + "ms": "^2.1.3" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "eng/tools/node_modules/emoji-regex": { + "version": "10.4.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.4.0.tgz", + "integrity": "sha512-EC+0oUMY1Rqm4O6LLrgjtYDvcVYTy7chDnM4Q7030tP4Kwj3u/pR6gP9ygnp2CJMK5Gq+9Q2oqmrFJAz01DXjw==", + "dev": true, + "license": "MIT" + }, "eng/tools/node_modules/entities": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/entities/-/entities-3.0.1.tgz", @@ -516,17 +369,40 @@ "url": "https://github.com/fb55/entities?sponsor=1" } }, - "eng/tools/node_modules/find-up": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", - "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", + "eng/tools/node_modules/eslint-plugin-unicorn": { + "version": "61.0.2", + "resolved": "https://registry.npmjs.org/eslint-plugin-unicorn/-/eslint-plugin-unicorn-61.0.2.tgz", + "integrity": "sha512-zLihukvneYT7f74GNbVJXfWIiNQmkc/a9vYBTE4qPkQZswolWNdu+Wsp9sIXno1JOzdn6OUwLPd19ekXVkahRA==", "dev": true, "license": "MIT", "dependencies": { - "locate-path": "^3.0.0" + "@babel/helper-validator-identifier": "^7.27.1", + "@eslint-community/eslint-utils": "^4.7.0", + "@eslint/plugin-kit": "^0.3.3", + "change-case": "^5.4.4", + "ci-info": "^4.3.0", + "clean-regexp": "^1.0.0", + "core-js-compat": "^3.44.0", + "esquery": "^1.6.0", + "find-up-simple": "^1.0.1", + "globals": "^16.3.0", + "indent-string": "^5.0.0", + "is-builtin-module": "^5.0.0", + "jsesc": "^3.1.0", + "pluralize": "^8.0.0", + "regexp-tree": "^0.1.27", + "regjsparser": "^0.12.0", + "semver": "^7.7.2", + "strip-indent": "^4.0.0" }, "engines": { - "node": ">=6" + "node": "^20.10.0 || >=21.0.0" + }, + "funding": { + "url": "https://github.com/sindresorhus/eslint-plugin-unicorn?sponsor=1" + }, + "peerDependencies": { + "eslint": ">=9.29.0" } }, "eng/tools/node_modules/glob": { @@ -553,16 +429,6 @@ "url": "https://github.com/sponsors/isaacs" } }, - "eng/tools/node_modules/is-fullwidth-code-point": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", - "integrity": "sha512-VHskAKYM8RfSFXwee5t5cbN5PZeq1Wrh6qd5bkyiXIf6UQcN6w/A0eXM9r6t8d+GYOh+o6ZhiEnb88LN/Y8m2w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=4" - } - }, "eng/tools/node_modules/jackspeak": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-4.1.1.tgz", @@ -586,33 +452,12 @@ "dev": true, "license": "MIT" }, - "eng/tools/node_modules/jsonpath-plus": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/jsonpath-plus/-/jsonpath-plus-8.1.0.tgz", - "integrity": "sha512-qVTiuKztFGw0dGhYi3WNqvddx3/SHtyDT0xJaeyz4uP0d1tkpG+0y5uYQ4OcIo1TLAz3PE/qDOW9F0uDt3+CTw==", - "dev": true, - "license": "MIT", - "bin": { - "jsonpath": "bin/jsonpath-cli.js", - "jsonpath-plus": "bin/jsonpath-cli.js" - }, - "engines": { - "node": ">=14.0.0" - } - }, - "eng/tools/node_modules/locate-path": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", - "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", + "eng/tools/node_modules/jsonc-parser": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.3.1.tgz", + "integrity": "sha512-HUgH65KyejrUFPvHFPbqOY0rsFip3Bo5wb4ngvdi1EpCYWUQDC5V+Y7mZws+DLkr4M//zQJoanu1SP+87Dv1oQ==", "dev": true, - "license": "MIT", - "dependencies": { - "p-locate": "^3.0.0", - "path-exists": "^3.0.0" - }, - "engines": { - "node": ">=6" - } + "license": "MIT" }, "eng/tools/node_modules/lru-cache": { "version": "11.1.0", @@ -625,9 +470,9 @@ } }, "eng/tools/node_modules/marked": { - "version": "16.2.0", - "resolved": "https://registry.npmjs.org/marked/-/marked-16.2.0.tgz", - "integrity": "sha512-LbbTuye+0dWRz2TS9KJ7wsnD4KAtpj0MVkWc90XvBa6AslXsT0hTBVH5k32pcSyHH1fst9XEFJunXHktVy0zlg==", + "version": "16.3.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-16.3.0.tgz", + "integrity": "sha512-K3UxuKu6l6bmA5FUwYho8CfJBlsUWAooKtdGgMcERSpF7gcBUrCGsLH7wDaaNOzwq18JzSUDyoEb/YsrqMac3w==", "dev": true, "license": "MIT", "bin": { @@ -653,45 +498,6 @@ "url": "https://github.com/sponsors/isaacs" } }, - "eng/tools/node_modules/p-limit": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", - "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", - "dev": true, - "license": "MIT", - "dependencies": { - "p-try": "^2.0.0" - }, - "engines": { - "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "eng/tools/node_modules/p-locate": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", - "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "p-limit": "^2.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "eng/tools/node_modules/path-exists": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", - "integrity": "sha512-bpC7GYwiDYQ4wYLe+FA8lhRjhQCMcQGuSgGGqDkg/QerRWw9CmGRT0iSOVRSZJ29NMLZgIzqaljJ63oaL4NIJQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=4" - } - }, "eng/tools/node_modules/path-scurry": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-2.0.0.tgz", @@ -709,16 +515,6 @@ "url": "https://github.com/sponsors/isaacs" } }, - "eng/tools/node_modules/source-map": { - "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": ">= 12" - } - }, "eng/tools/node_modules/string-width": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.2.0.tgz", @@ -806,13 +602,23 @@ "node": "^20.19.0 || ^22.12.0 || >=23" } }, + "eng/tools/node_modules/zod": { + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/zod/-/zod-4.1.8.tgz", + "integrity": "sha512-5R1P+WwQqmmMIEACyzSvo4JXHY5WiAFHRMg+zBZKgKS+Q1viRa0C1hmUKtHltoIFKtIdki3pRxkmpP74jnNYHQ==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/colinhacks" + } + }, "eng/tools/oav-runner": { "name": "@azure-tools/oav-runner", "dev": true, "dependencies": { "@azure-tools/specs-shared": "file:../../../.github/shared", "js-yaml": "^4.1.0", - "oav": "^4.0.0", + "oav": "4.0.0", "simple-git": "^3.27.0" }, "bin": { @@ -858,7 +664,7 @@ "dependencies": { "@azure-tools/specs-shared": "file:../../../.github/shared", "ajv": "^8.17.1", - "debug": "^4.4.0", + "debug": "^4.4.3", "lodash": "^4.17.20", "simple-git": "^3.27.0", "yaml": "^2.4.2" @@ -892,7 +698,7 @@ "@types/node": "^20.0.0", "@vitest/coverage-v8": "^3.1.2", "eslint": "^9.21.0", - "eslint-plugin-unicorn": "^60.0.0", + "eslint-plugin-unicorn": "^61.0.2", "prettier": "~3.6.2", "prettier-plugin-organize-imports": "^4.2.0", "typescript": "~5.8.2", @@ -940,7 +746,7 @@ "dependencies": { "minimatch": "^10.0.1", "yaml": "^2.4.2", - "zod": "^4.0.2" + "zod": "^4.1.8" }, "bin": { "get-suppressions": "cmd/get-suppressions.js" @@ -1027,7 +833,7 @@ "dev": true, "dependencies": { "@azure-tools/specs-shared": "file:../../../.github/shared", - "debug": "^4.4.0", + "debug": "^4.4.3", "globby": "^14.0.1", "picocolors": "^1.1.1", "simple-git": "^3.24.0", @@ -1065,25 +871,6 @@ "node": ">=6.0.0" } }, - "node_modules/@apidevtools/json-schema-ref-parser": { - "version": "14.2.0", - "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-14.2.0.tgz", - "integrity": "sha512-NaGMMWwppbByagq+LwQMq6PMXHFWVu6kSwwx+eJfYTJ5zdpOvb9TIk6ZWxEEeXMUvGdVOZq3JalYsjsTZDvtkA==", - "dev": true, - "license": "MIT", - "dependencies": { - "js-yaml": "^4.1.0" - }, - "engines": { - "node": ">= 20" - }, - "funding": { - "url": "https://github.com/sponsors/philsturgeon" - }, - "peerDependencies": { - "@types/json-schema": "^7.0.15" - } - }, "node_modules/@apidevtools/openapi-schemas": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/@apidevtools/openapi-schemas/-/openapi-schemas-2.1.0.tgz", @@ -1219,9 +1006,9 @@ } }, "node_modules/@autorest/openapi-to-typespec": { - "version": "0.11.9", - "resolved": "https://registry.npmjs.org/@autorest/openapi-to-typespec/-/openapi-to-typespec-0.11.9.tgz", - "integrity": "sha512-vDE0+uj6+krWED6ux0ODGZ/40CDwRmDSv/5MK5918wyr8I7ZywlHH0xFME1XxnGKXaLk1TpEdo84clKL2KO0VA==", + "version": "0.11.10", + "resolved": "https://registry.npmjs.org/@autorest/openapi-to-typespec/-/openapi-to-typespec-0.11.10.tgz", + "integrity": "sha512-1bP26wuUioqHxhV11o48VthMCkOwHhiHwJ9ebaINf/NvVKU9YNTXbzStKUclS4vpRpk2Zb/VSmE1TZfAomI/mg==", "dev": true, "license": "MIT", "dependencies": { @@ -1229,7 +1016,7 @@ "@autorest/extension-base": "~3.6.1", "@azure-tools/codegen": "~2.10.1", "@azure-tools/openapi": "~3.6.1", - "@typespec/prettier-plugin-typespec": "^1.3.0", + "@typespec/prettier-plugin-typespec": "^1.4.0", "change-case-all": "~2.1.0", "lodash": "~4.17.20", "pluralize": "^8.0.0", @@ -1600,9 +1387,9 @@ } }, "node_modules/@azure-tools/typespec-client-generator-core": { - "version": "0.60.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.60.0.tgz", - "integrity": "sha512-JV9uiqxDCzVVFeMctm4ebmUI4982B3dCdKx0nmonjfRf9a2/MXilEKExPIaNVR3ZqbFPXM/IepheY8t9YZNqSQ==", + "version": "0.60.1", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.60.1.tgz", + "integrity": "sha512-JnTUhFfeRJxznU8Q7LEBzg/HoNO13SAXxpmFM8JFrzNqchATTpaKGBuYE1NUPJ9AiuK1lpkI/t/f7mtSGxUKXg==", "dev": true, "license": "MIT", "dependencies": { @@ -1674,9 +1461,9 @@ } }, "node_modules/@azure/avocado": { - "version": "0.9.2", - "resolved": "https://registry.npmjs.org/@azure/avocado/-/avocado-0.9.2.tgz", - "integrity": "sha512-dPbvYi1KpviObTaMNrQuaDPuzdPhe0r9QP9vRQ5kfqozbOpHcDjhWh652h9BaP80Nsb6G+cxKYHyj0XEqrSjEA==", + "version": "0.9.3", + "resolved": "https://registry.npmjs.org/@azure/avocado/-/avocado-0.9.3.tgz", + "integrity": "sha512-Re3vj01CrxMi2YjDRj3rRcxOKGhhqbiuD/tdV8ODQJE8AWV5CUswztF3gwvjM7N116lCkt7ppcQBKThJ11ouBQ==", "dev": true, "license": "MIT", "dependencies": { @@ -1690,7 +1477,7 @@ "@ts-common/json-parser": "^0.9.0", "@ts-common/string-map": "^0.3.0", "commonmark": "^0.29.0", - "glob": "^7.2.0", + "glob": "^9.3.5", "js-yaml": "^3.13.1", "jsonpath-plus": "^10.0.0", "node-fetch": ">=2.6.1", @@ -1725,6 +1512,16 @@ "sprintf-js": "~1.0.2" } }, + "node_modules/@azure/avocado/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/@azure/avocado/node_modules/cliui": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/cliui/-/cliui-6.0.0.tgz", @@ -1751,6 +1548,25 @@ "node": ">=8" } }, + "node_modules/@azure/avocado/node_modules/glob": { + "version": "9.3.5", + "resolved": "https://registry.npmjs.org/glob/-/glob-9.3.5.tgz", + "integrity": "sha512-e1LleDykUz2Iu+MTYdkSsuWX8lvAjAcs0Xef0lNIu0S2wOAzuTxCJtcd9S3cijlwYF18EsU3rzb8jPVobxDh9Q==", + "dev": true, + "license": "ISC", + "dependencies": { + "fs.realpath": "^1.0.0", + "minimatch": "^8.0.2", + "minipass": "^4.2.4", + "path-scurry": "^1.6.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "node_modules/@azure/avocado/node_modules/js-yaml": { "version": "3.14.1", "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", @@ -1778,6 +1594,32 @@ "node": ">=8" } }, + "node_modules/@azure/avocado/node_modules/minimatch": { + "version": "8.0.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-8.0.4.tgz", + "integrity": "sha512-W0Wvr9HyFXZRGIDgCicunpQ299OKXs9RgZfaukz4qAW/pJhcpUfupc9c+OObPOFueNy8VSrZgEmDtk6Kh4WzDA==", + "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/@azure/avocado/node_modules/minipass": { + "version": "4.2.8", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-4.2.8.tgz", + "integrity": "sha512-fNzuVyifolSLFL4NzpF+wEF4qrgqaaKX0haXPQEdQ7NKAN+WecoKMHV09YcuL/DHxrUsYQOK3MiuDf7Ip2OXfQ==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=8" + } + }, "node_modules/@azure/avocado/node_modules/p-limit": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", @@ -1887,196 +1729,461 @@ "dev": true, "license": "MIT", "dependencies": { - "@azure/abort-controller": "^1.0.0", - "@azure/core-auth": "^1.3.0", - "@azure/core-tracing": "1.0.0-preview.13", - "@azure/core-util": "^1.1.1", - "@azure/logger": "^1.0.0", - "@types/node-fetch": "^2.5.0", - "@types/tunnel": "^0.0.3", - "form-data": "^4.0.0", - "node-fetch": "^2.6.7", - "process": "^0.11.10", - "tslib": "^2.2.0", - "tunnel": "^0.0.6", - "uuid": "^8.3.0", - "xml2js": "^0.5.0" + "@azure/abort-controller": "^1.0.0", + "@azure/core-auth": "^1.3.0", + "@azure/core-tracing": "1.0.0-preview.13", + "@azure/core-util": "^1.1.1", + "@azure/logger": "^1.0.0", + "@types/node-fetch": "^2.5.0", + "@types/tunnel": "^0.0.3", + "form-data": "^4.0.0", + "node-fetch": "^2.6.7", + "process": "^0.11.10", + "tslib": "^2.2.0", + "tunnel": "^0.0.6", + "uuid": "^8.3.0", + "xml2js": "^0.5.0" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/@azure/core-http/node_modules/@azure/abort-controller": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-1.1.0.tgz", + "integrity": "sha512-TrRLIoSQVzfAJX9H1JeFjzAoDGcoK1IYX1UImfceTZpsyYfWr09Ss1aHW1y5TrrR3iq6RZLBwJ3E24uwPhwahw==", + "dev": true, + "license": "MIT", + "dependencies": { + "tslib": "^2.2.0" + }, + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/@azure/core-http/node_modules/@azure/core-tracing": { + "version": "1.0.0-preview.13", + "resolved": "https://registry.npmjs.org/@azure/core-tracing/-/core-tracing-1.0.0-preview.13.tgz", + "integrity": "sha512-KxDlhXyMlh2Jhj2ykX6vNEU0Vou4nHr025KoSEiz7cS3BNiHNaZcdECk/DmLkEB0as5T7b/TpRcehJ5yV6NeXQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@opentelemetry/api": "^1.0.1", + "tslib": "^2.2.0" + }, + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/@azure/core-http/node_modules/node-fetch": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "whatwg-url": "^5.0.0" + }, + "engines": { + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } + } + }, + "node_modules/@azure/core-rest-pipeline": { + "version": "1.22.0", + "resolved": "https://registry.npmjs.org/@azure/core-rest-pipeline/-/core-rest-pipeline-1.22.0.tgz", + "integrity": "sha512-OKHmb3/Kpm06HypvB3g6Q3zJuvyXcpxDpCS1PnU8OV6AJgSFaee/covXBcPbWc6XDDxtEPlbi3EMQ6nUiPaQtw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@azure/abort-controller": "^2.0.0", + "@azure/core-auth": "^1.8.0", + "@azure/core-tracing": "^1.0.1", + "@azure/core-util": "^1.11.0", + "@azure/logger": "^1.0.0", + "@typespec/ts-http-runtime": "^0.3.0", + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=20.0.0" + } + }, + "node_modules/@azure/core-tracing": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@azure/core-tracing/-/core-tracing-1.3.0.tgz", + "integrity": "sha512-+XvmZLLWPe67WXNZo9Oc9CrPj/Tm8QnHR92fFAFdnbzwNdCH1h+7UdpaQgRSBsMY+oW1kHXNUZQLdZ1gHX3ROw==", + "dev": true, + "license": "MIT", + "dependencies": { + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=20.0.0" + } + }, + "node_modules/@azure/core-util": { + "version": "1.13.0", + "resolved": "https://registry.npmjs.org/@azure/core-util/-/core-util-1.13.0.tgz", + "integrity": "sha512-o0psW8QWQ58fq3i24Q1K2XfS/jYTxr7O1HRcyUE9bV9NttLU+kYOH82Ixj8DGlMTOWgxm1Sss2QAfKK5UkSPxw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@azure/abort-controller": "^2.0.0", + "@typespec/ts-http-runtime": "^0.3.0", + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=20.0.0" + } + }, + "node_modules/@azure/logger": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@azure/logger/-/logger-1.3.0.tgz", + "integrity": "sha512-fCqPIfOcLE+CGqGPd66c8bZpwAji98tZ4JI9i/mlTNTlsIWslCfpg48s/ypyLxZTump5sypjrKn2/kY7q8oAbA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typespec/ts-http-runtime": "^0.3.0", + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=20.0.0" + } + }, + "node_modules/@azure/ms-rest-js": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/@azure/ms-rest-js/-/ms-rest-js-2.7.0.tgz", + "integrity": "sha512-ngbzWbqF+NmztDOpLBVDxYM+XLcUj7nKhxGbSU9WtIsXfRB//cf2ZbAG5HkOrhU9/wd/ORRB6lM/d69RKVjiyA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@azure/core-auth": "^1.1.4", + "abort-controller": "^3.0.0", + "form-data": "^2.5.0", + "node-fetch": "^2.6.7", + "tslib": "^1.10.0", + "tunnel": "0.0.6", + "uuid": "^8.3.2", + "xml2js": "^0.5.0" + } + }, + "node_modules/@azure/ms-rest-js/node_modules/form-data": { + "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" + }, + "engines": { + "node": ">= 0.12" + } + }, + "node_modules/@azure/ms-rest-js/node_modules/node-fetch": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "whatwg-url": "^5.0.0" + }, + "engines": { + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } + } + }, + "node_modules/@azure/ms-rest-js/node_modules/tslib": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "dev": true, + "license": "0BSD" + }, + "node_modules/@azure/oad": { + "version": "0.12.0", + "resolved": "https://registry.npmjs.org/@azure/oad/-/oad-0.12.0.tgz", + "integrity": "sha512-o7JURA54DgTk0DXDjJuWMUtHBo9Qbhz/OR0Dw+QYwnPzEwdqjWhoe7WBlvtrGu5JhRnjLDfbTA4te0rkWkiwBw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@ts-common/fs": "^0.2.0", + "@ts-common/iterator": "^0.3.6", + "@ts-common/json": "^0.3.1", + "@ts-common/json-parser": "^0.9.0", + "@ts-common/source-map": "^0.5.0", + "@ts-common/string-map": "^0.3.0", + "acorn": "^5.7.4", + "autorest": "^3.6.1", + "glob": "^7.1.3", + "js-yaml": "^3.13.1", + "json-pointer": "^0.6.2", + "json-refs": "^3.0.15", + "kind-of": "^6.0.3", + "lodash": "^4.17.21", + "minimist": "^1.2.8", + "set-value": "^4.1.0", + "source-map": "^0.7.4", + "tslib": "^2.6.3", + "winston": "^3.13.0", + "yargs": "^13.2.2", + "yargs-parser": "^13.1.2" + }, + "bin": { + "oad": "dist/cli.js" + }, + "engines": { + "node": ">=20.0.0" + } + }, + "node_modules/@azure/oad/node_modules/@ts-common/iterator": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", + "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", + "dev": true, + "license": "Apache-2.0" + }, + "node_modules/@azure/oad/node_modules/acorn": { + "version": "5.7.4", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-5.7.4.tgz", + "integrity": "sha512-1D++VG7BhrtvQpNbBzovKNc1FLGGEE/oGe7b9xJm/RFHMBeUaUGpluV9RLjZa47YFdPcDAenEYuq9pQPcMdLJg==", + "dev": true, + "license": "MIT", + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/@azure/oad/node_modules/ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^1.9.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@azure/oad/node_modules/argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "dev": true, + "license": "MIT", + "dependencies": { + "sprintf-js": "~1.0.2" + } + }, + "node_modules/@azure/oad/node_modules/cliui": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-5.0.0.tgz", + "integrity": "sha512-PYeGSEmmHM6zvoef2w8TPzlrnNpXIjTipYK780YswmIP9vjxmd6Y2a3CB2Ks6/AU8NHjZugXvo8w3oWM2qnwXA==", + "dev": true, + "license": "ISC", + "dependencies": { + "string-width": "^3.1.0", + "strip-ansi": "^5.2.0", + "wrap-ansi": "^5.1.0" + } + }, + "node_modules/@azure/oad/node_modules/emoji-regex": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", + "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@azure/oad/node_modules/find-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", + "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", + "dev": true, + "license": "MIT", + "dependencies": { + "locate-path": "^3.0.0" }, "engines": { - "node": ">=18.0.0" + "node": ">=6" } }, - "node_modules/@azure/core-http/node_modules/@azure/abort-controller": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-1.1.0.tgz", - "integrity": "sha512-TrRLIoSQVzfAJX9H1JeFjzAoDGcoK1IYX1UImfceTZpsyYfWr09Ss1aHW1y5TrrR3iq6RZLBwJ3E24uwPhwahw==", + "node_modules/@azure/oad/node_modules/is-fullwidth-code-point": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", + "integrity": "sha512-VHskAKYM8RfSFXwee5t5cbN5PZeq1Wrh6qd5bkyiXIf6UQcN6w/A0eXM9r6t8d+GYOh+o6ZhiEnb88LN/Y8m2w==", "dev": true, "license": "MIT", - "dependencies": { - "tslib": "^2.2.0" - }, "engines": { - "node": ">=12.0.0" + "node": ">=4" } }, - "node_modules/@azure/core-http/node_modules/@azure/core-tracing": { - "version": "1.0.0-preview.13", - "resolved": "https://registry.npmjs.org/@azure/core-tracing/-/core-tracing-1.0.0-preview.13.tgz", - "integrity": "sha512-KxDlhXyMlh2Jhj2ykX6vNEU0Vou4nHr025KoSEiz7cS3BNiHNaZcdECk/DmLkEB0as5T7b/TpRcehJ5yV6NeXQ==", + "node_modules/@azure/oad/node_modules/js-yaml": { + "version": "3.14.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", + "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==", "dev": true, "license": "MIT", "dependencies": { - "@opentelemetry/api": "^1.0.1", - "tslib": "^2.2.0" + "argparse": "^1.0.7", + "esprima": "^4.0.0" }, - "engines": { - "node": ">=12.0.0" + "bin": { + "js-yaml": "bin/js-yaml.js" } }, - "node_modules/@azure/core-http/node_modules/node-fetch": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", - "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "node_modules/@azure/oad/node_modules/locate-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", + "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", "dev": true, "license": "MIT", "dependencies": { - "whatwg-url": "^5.0.0" + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" }, "engines": { - "node": "4.x || >=6.0.0" - }, - "peerDependencies": { - "encoding": "^0.1.0" - }, - "peerDependenciesMeta": { - "encoding": { - "optional": true - } + "node": ">=6" } }, - "node_modules/@azure/core-rest-pipeline": { - "version": "1.22.0", - "resolved": "https://registry.npmjs.org/@azure/core-rest-pipeline/-/core-rest-pipeline-1.22.0.tgz", - "integrity": "sha512-OKHmb3/Kpm06HypvB3g6Q3zJuvyXcpxDpCS1PnU8OV6AJgSFaee/covXBcPbWc6XDDxtEPlbi3EMQ6nUiPaQtw==", + "node_modules/@azure/oad/node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", "dev": true, "license": "MIT", "dependencies": { - "@azure/abort-controller": "^2.0.0", - "@azure/core-auth": "^1.8.0", - "@azure/core-tracing": "^1.0.1", - "@azure/core-util": "^1.11.0", - "@azure/logger": "^1.0.0", - "@typespec/ts-http-runtime": "^0.3.0", - "tslib": "^2.6.2" + "p-try": "^2.0.0" }, "engines": { - "node": ">=20.0.0" + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/@azure/core-tracing": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/@azure/core-tracing/-/core-tracing-1.3.0.tgz", - "integrity": "sha512-+XvmZLLWPe67WXNZo9Oc9CrPj/Tm8QnHR92fFAFdnbzwNdCH1h+7UdpaQgRSBsMY+oW1kHXNUZQLdZ1gHX3ROw==", + "node_modules/@azure/oad/node_modules/p-locate": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", + "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", "dev": true, "license": "MIT", "dependencies": { - "tslib": "^2.6.2" + "p-limit": "^2.0.0" }, "engines": { - "node": ">=20.0.0" + "node": ">=6" } }, - "node_modules/@azure/core-util": { - "version": "1.13.0", - "resolved": "https://registry.npmjs.org/@azure/core-util/-/core-util-1.13.0.tgz", - "integrity": "sha512-o0psW8QWQ58fq3i24Q1K2XfS/jYTxr7O1HRcyUE9bV9NttLU+kYOH82Ixj8DGlMTOWgxm1Sss2QAfKK5UkSPxw==", + "node_modules/@azure/oad/node_modules/path-exists": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", + "integrity": "sha512-bpC7GYwiDYQ4wYLe+FA8lhRjhQCMcQGuSgGGqDkg/QerRWw9CmGRT0iSOVRSZJ29NMLZgIzqaljJ63oaL4NIJQ==", "dev": true, "license": "MIT", - "dependencies": { - "@azure/abort-controller": "^2.0.0", - "@typespec/ts-http-runtime": "^0.3.0", - "tslib": "^2.6.2" - }, "engines": { - "node": ">=20.0.0" + "node": ">=4" } }, - "node_modules/@azure/logger": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/@azure/logger/-/logger-1.3.0.tgz", - "integrity": "sha512-fCqPIfOcLE+CGqGPd66c8bZpwAji98tZ4JI9i/mlTNTlsIWslCfpg48s/ypyLxZTump5sypjrKn2/kY7q8oAbA==", + "node_modules/@azure/oad/node_modules/source-map": { + "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": "MIT", - "dependencies": { - "@typespec/ts-http-runtime": "^0.3.0", - "tslib": "^2.6.2" - }, + "license": "BSD-3-Clause", "engines": { - "node": ">=20.0.0" + "node": ">= 12" } }, - "node_modules/@azure/ms-rest-js": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/@azure/ms-rest-js/-/ms-rest-js-2.7.0.tgz", - "integrity": "sha512-ngbzWbqF+NmztDOpLBVDxYM+XLcUj7nKhxGbSU9WtIsXfRB//cf2ZbAG5HkOrhU9/wd/ORRB6lM/d69RKVjiyA==", + "node_modules/@azure/oad/node_modules/string-width": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", + "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", "dev": true, "license": "MIT", "dependencies": { - "@azure/core-auth": "^1.1.4", - "abort-controller": "^3.0.0", - "form-data": "^2.5.0", - "node-fetch": "^2.6.7", - "tslib": "^1.10.0", - "tunnel": "0.0.6", - "uuid": "^8.3.2", - "xml2js": "^0.5.0" + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" + }, + "engines": { + "node": ">=6" } }, - "node_modules/@azure/ms-rest-js/node_modules/form-data": { - "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==", + "node_modules/@azure/oad/node_modules/wrap-ansi": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-5.1.0.tgz", + "integrity": "sha512-QC1/iN/2/RPVJ5jYK8BGttj5z83LmSKmvbvrXPNCLZSEb32KKVDJDl/MOt2N01qU2H/FkzEa9PKto1BqDjtd7Q==", "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" + "ansi-styles": "^3.2.0", + "string-width": "^3.0.0", + "strip-ansi": "^5.0.0" }, "engines": { - "node": ">= 0.12" + "node": ">=6" } }, - "node_modules/@azure/ms-rest-js/node_modules/node-fetch": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", - "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "node_modules/@azure/oad/node_modules/y18n": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.3.tgz", + "integrity": "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/@azure/oad/node_modules/yargs": { + "version": "13.3.2", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-13.3.2.tgz", + "integrity": "sha512-AX3Zw5iPruN5ie6xGRIDgqkT+ZhnRlZMLMHAs8tg7nRruy2Nb+i5o9bwghAogtM08q1dpr2LVoS8KSTMYpWXUw==", "dev": true, "license": "MIT", "dependencies": { - "whatwg-url": "^5.0.0" - }, - "engines": { - "node": "4.x || >=6.0.0" - }, - "peerDependencies": { - "encoding": "^0.1.0" - }, - "peerDependenciesMeta": { - "encoding": { - "optional": true - } + "cliui": "^5.0.0", + "find-up": "^3.0.0", + "get-caller-file": "^2.0.1", + "require-directory": "^2.1.1", + "require-main-filename": "^2.0.0", + "set-blocking": "^2.0.0", + "string-width": "^3.0.0", + "which-module": "^2.0.0", + "y18n": "^4.0.0", + "yargs-parser": "^13.1.2" } }, - "node_modules/@azure/ms-rest-js/node_modules/tslib": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", - "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "node_modules/@azure/oad/node_modules/yargs-parser": { + "version": "13.1.2", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-13.1.2.tgz", + "integrity": "sha512-3lbsNRf/j+A4QuSZfDRA7HRSfWrzO0YjqTJd5kjAq37Zep1CEgaYmrH9Q3GwPiB9cHyd1Y1UwggGhJGoxipbzg==", "dev": true, - "license": "0BSD" + "license": "ISC", + "dependencies": { + "camelcase": "^5.0.0", + "decamelize": "^1.2.0" + } }, "node_modules/@azure/openapi-markdown": { "version": "0.9.4", @@ -7478,42 +7585,6 @@ } } }, - "node_modules/eslint-plugin-unicorn": { - "version": "60.0.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-unicorn/-/eslint-plugin-unicorn-60.0.0.tgz", - "integrity": "sha512-QUzTefvP8stfSXsqKQ+vBQSEsXIlAiCduS/V1Em+FKgL9c21U/IIm20/e3MFy1jyCf14tHAhqC1sX8OTy6VUCg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-validator-identifier": "^7.27.1", - "@eslint-community/eslint-utils": "^4.7.0", - "@eslint/plugin-kit": "^0.3.3", - "change-case": "^5.4.4", - "ci-info": "^4.3.0", - "clean-regexp": "^1.0.0", - "core-js-compat": "^3.44.0", - "esquery": "^1.6.0", - "find-up-simple": "^1.0.1", - "globals": "^16.3.0", - "indent-string": "^5.0.0", - "is-builtin-module": "^5.0.0", - "jsesc": "^3.1.0", - "pluralize": "^8.0.0", - "regexp-tree": "^0.1.27", - "regjsparser": "^0.12.0", - "semver": "^7.7.2", - "strip-indent": "^4.0.0" - }, - "engines": { - "node": "^20.10.0 || >=21.0.0" - }, - "funding": { - "url": "https://github.com/sindresorhus/eslint-plugin-unicorn?sponsor=1" - }, - "peerDependencies": { - "eslint": ">=9.29.0" - } - }, "node_modules/eslint-scope": { "version": "8.4.0", "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-8.4.0.tgz", @@ -13609,16 +13680,6 @@ "optionalDependencies": { "commander": "^9.4.1" } - }, - "node_modules/zod": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/zod/-/zod-4.1.1.tgz", - "integrity": "sha512-SgMZK/h8Tigt9nnKkfJMvB/mKjiJXaX26xegP4sa+0wHIFVFWVlsQGdhklDmuargBD3Hsi3rsQRIzwJIhTPJHA==", - "dev": true, - "license": "MIT", - "funding": { - "url": "https://github.com/sponsors/colinhacks" - } } } } diff --git a/package.json b/package.json index 55baf27ec3e8..977fd00c2f1d 100644 --- a/package.json +++ b/package.json @@ -10,10 +10,11 @@ "@azure-tools/typespec-azure-resource-manager": "0.60.0", "@azure-tools/typespec-azure-rulesets": "0.60.0", "@azure-tools/typespec-client-generator-cli": "0.28.1", - "@azure-tools/typespec-client-generator-core": "0.60.0", + "@azure-tools/typespec-client-generator-core": "0.60.1", "@azure-tools/typespec-liftr-base": "0.8.0", - "@autorest/openapi-to-typespec": "0.11.9", - "@azure/avocado": "^0.9.1", + "@autorest/openapi-to-typespec": "0.11.10", + "@azure/avocado": "0.9.3", + "@azure/oad": "0.12.0", "@microsoft.azure/openapi-validator": "2.2.4", "@microsoft.azure/openapi-validator-core": "1.0.6", "@microsoft.azure/openapi-validator-rulesets": "2.1.7", @@ -29,7 +30,7 @@ "@typespec/versioning": "0.74.0", "@typespec/xml": "0.74.0", "azure-rest-api-specs-eng-tools": "file:eng/tools", - "oav": "^4.0.0", + "oav": "4.0.0", "prettier": "~3.6.2", "typescript": "~5.8.2" }, diff --git a/specification/advisor/resource-manager/sdk-suppressions.yaml b/specification/advisor/resource-manager/sdk-suppressions.yaml index 49e56635406f..ed277be5c0dd 100644 --- a/specification/advisor/resource-manager/sdk-suppressions.yaml +++ b/specification/advisor/resource-manager/sdk-suppressions.yaml @@ -1,5 +1,5 @@ -suppressions: - azure-sdk-for-python: - - package: azure-mgmt-advisor - breaking-changes: +suppressions: + azure-sdk-for-python: + - package: azure-mgmt-advisor + breaking-changes: - Method `AdvisorManagementClient.__init__` parameter `base_url` changed default value from `None` to `str` \ No newline at end of file