Add AOAI 2024-05-01-preview API version #29042

YunsongB · 2024-05-09T00:37:54Z

Data Plane API Specification Update Pull Request

Add AOAI 2024-05-01-preview API version.

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

Link to API Spec engagement record issue:

Is this review for (select one):

a private preview
a public preview
GA release

Change Scope

^{This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.}

Design Document:
Previous API Spec Doc:
Updated paths:

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

💬 Teams Channel
💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Open API validation tools were run on this PR. Go here to see how to fix errors
Spectral Linting

Guidelines & Specifications

Helpful Links

Schedule a data plane REST API spec review

Getting help

First, please carefully read through this PR description, from top to bottom.
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

openapi-pipeline-app · 2024-05-09T00:37:58Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ Your PR requires an API stewardship board review as it introduces a new API version (label: new-api-version). Schedule the review by following aka.ms/azsdk/onboarding/restapischedule.
❌ The required check named Swagger PrettierCheck has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it

openapi-pipeline-app · 2024-05-09T00:37:59Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️❌Breaking Change(Cross-Version): 4 Errors, 0 Warnings failed [Detail]

The following breaking changes are detected by comparison with the latest stable version:

Rule	Message
`❌` Runtime Exception	"new":"https://github.com/Azure/azure-rest-api-specs/blob/8c0d7cd24cced3df289c1392ae5d646420ef2a99/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-02-01/azureopenai.json", "details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 20 lines of stack trace follow, indexed. First line should contain AutoRest command line invocation details. Remaining lines should contain the main message reported by AutoRest. ==================== 1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@Azure [email protected]/node_modules/autorest/dist/app.js" --v2 --input-file=specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp/oad-hdVqON 2: ERROR: Schema violation: Expected type boolean but found type string 3: 4: code: 'INVALID-TYPE', 5: params: [ 'boolean', 'string' ], 6: message: 'Expected type boolean but found type string', 7: path: '#/definitions/TargetType/x-ms-enum/modelAsString', 8: schemaId: 'https://raw.githubusercontent.com/Azure/autorest/master/schema/swagger-extensions.json#' 9: 10: - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.json:2127:6 ($.definitions.TargetType["x-ms-enum"].modelAsString) 11: FATAL: swagger-document/individual/schema-validator - FAILED 12: FATAL: Error: [OperationAbortedException] Error occurred. Exiting. 13: Process() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting."
`❌` Runtime Exception	"new":"https://github.com/Azure/azure-rest-api-specs/blob/8c0d7cd24cced3df289c1392ae5d646420ef2a99/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/inference.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/inference.json", "details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 20 lines of stack trace follow, indexed. First line should contain AutoRest command line invocation details. Remaining lines should contain the main message reported by AutoRest. ==================== 1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@Azure [email protected]/node_modules/autorest/dist/app.js" --v2 --input-file=/mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/inference.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp/oad-0JdKZK 2: FATAL: swagger-document/loader - FAILED 3: FATAL: Error: File 'file:///mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/inference.json' is not a valid OpenAPI 2.0 definition (expected 'swagger: 2.0') 4: Error: File 'file:///mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/inference.json' is not a valid OpenAPI 2.0 definition (expected 'swagger: 2.0')"

The following breaking changes are detected by comparison with the latest preview version:

Rule	Message
`❌` Runtime Exception	"new":"https://github.com/Azure/azure-rest-api-specs/blob/8c0d7cd24cced3df289c1392ae5d646420ef2a99/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-04-01-preview/azureopenai.json", "details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 20 lines of stack trace follow, indexed. First line should contain AutoRest command line invocation details. Remaining lines should contain the main message reported by AutoRest. ==================== 1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@Azure [email protected]/node_modules/autorest/dist/app.js" --v2 --input-file=specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp/oad-mcjzVL 2: ERROR: Schema violation: Expected type boolean but found type string 3: 4: code: 'INVALID-TYPE', 5: params: [ 'boolean', 'string' ], 6: message: 'Expected type boolean but found type string', 7: path: '#/definitions/TargetType/x-ms-enum/modelAsString', 8: schemaId: 'https://raw.githubusercontent.com/Azure/autorest/master/schema/swagger-extensions.json#' 9: 10: - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.json:2127:6 ($.definitions.TargetType["x-ms-enum"].modelAsString) 11: FATAL: swagger-document/individual/schema-validator - FAILED 12: FATAL: Error: [OperationAbortedException] Error occurred. Exiting. 13: Process() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting."
`❌` Runtime Exception	"new":"https://github.com/Azure/azure-rest-api-specs/blob/8c0d7cd24cced3df289c1392ae5d646420ef2a99/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/inference.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/inference.json", "details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 20 lines of stack trace follow, indexed. First line should contain AutoRest command line invocation details. Remaining lines should contain the main message reported by AutoRest. ==================== 1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@Azure [email protected]/node_modules/autorest/dist/app.js" --v2 --input-file=/mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/inference.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp/oad-NfaNuJ 2: FATAL: swagger-document/loader - FAILED 3: FATAL: Error: File 'file:///mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/inference.json' is not a valid OpenAPI 2.0 definition (expected 'swagger: 2.0') 4: Error: File 'file:///mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/inference.json' is not a valid OpenAPI 2.0 definition (expected 'swagger: 2.0')"

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️❌LintDiff: 23 Errors, 92 Warnings failed [Detail]

[must fix]The following errors/warnings are introduced by current PR:

Only 21 items are listed, please refer to log for more details.

Rule	Message	Related RPC [For API reviewers]
`❌` MissingTypeObject	The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L1976
`❌` MissingTypeObject	The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2004
`❌` MissingTypeObject	The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2068
`❌` MissingTypeObject	The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2092
`❌` MissingTypeObject	The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2156
`❌` MissingTypeObject	The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2176
`❌` MissingTypeObject	The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2204
`❌` MissingTypeObject	The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2265
`❌` MissingTypeObject	The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2300
`❌` UniqueXmsEnumName	Must not have duplicate name of x-ms-enum extension , make sure every x-ms-enum name unique. The duplicate x-ms-enum name: datasourcetype, path: $['UserComputeDatasourceType'] Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2338
`❌` MissingTypeObject	The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2375
`❌` MissingTypeObject	The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2411
`❌` MissingTypeObject	The schema 'ChunkingSettings' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2442
`❌` MissingTypeObject	The schema 'CrawlingSettings' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2451
`❌` MissingTypeObject	The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2572
`❌` MissingTypeObject	The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2596
`❌` MissingTypeObject	The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2615
`❌` MissingTypeObject	The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2634
`❌` invalid-ref	'#/definitions/OperationState' does not exist Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2726
`❌` AutoRest exception	"tag":"release_2024_05_01_preview", "details":"Schema violation: must be boolean (definitions > TargetType > x-ms-enum > modelAsString)"
`❌` AutoRest exception	"tag":"release_2024_05_01_preview", "details":"Plugin 'schema-validator-swagger' completed with some error."

The following errors/warnings exist before current PR submission:

Only 21 items are listed, please refer to log for more details.

Rule	Message
⚠️ PageableOperation	Based on the response model schema, operation 'Files_List' might be pageable. Consider adding the x-ms-pageable extension. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L10
⚠️ PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L10
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L65
⚠️ Formdata	Check for appropriate use of formData parameters. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L94
⚠️ Formdata	Check for appropriate use of formData parameters. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L129
⚠️ Post201Response	Using post for a create operation is discouraged. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L138
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L151
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: authoring/preview/2024-05-01-preview/azureopenai.json#L176
⚠️ ParameterNamesConvention	Parameter name 'file-id' should be camel case. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L178
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L194
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: authoring/preview/2024-05-01-preview/azureopenai.json#L217
⚠️ ParameterNamesConvention	Parameter name 'file-id' should be camel case. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L219
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L232
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: authoring/preview/2024-05-01-preview/azureopenai.json#L258
⚠️ ParameterNamesConvention	Parameter name 'file-id' should be camel case. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L260
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L276
⚠️ Post201Response	Using post for a create operation is discouraged. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L318
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L331
⚠️ PageableOperation	Based on the response model schema, operation 'Models_List' might be pageable. Consider adding the x-ms-pageable extension. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L687
⚠️ PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L687
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-05-01-preview/azureopenai.json#L708

️❌Avocado: 10 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: data-plane/AzureOpenAI/inference/readme.md json: preview/2024-05-01-preview/examples/delete_assistant_file.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: data-plane/AzureOpenAI/inference/readme.md json: preview/2024-05-01-preview/examples/delete_message.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: data-plane/AzureOpenAI/inference/readme.md json: preview/2024-05-01-preview/examples/get_assistant_file.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: data-plane/AzureOpenAI/inference/readme.md json: preview/2024-05-01-preview/examples/get_message_file.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: data-plane/AzureOpenAI/inference/readme.md json: preview/2024-05-01-preview/examples/list_assistant_files.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: data-plane/AzureOpenAI/inference/readme.md json: preview/2024-05-01-preview/examples/list_message_files.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: data-plane/AzureOpenAI/inference/readme.md json: preview/2024-05-01-preview/examples/list_vector_store_file_batch.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: data-plane/AzureOpenAI/inference/readme.md json: preview/2024-05-01-preview/examples/retrieve_message.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: data-plane/AzureOpenAI/inference/readme.md json: preview/2024-05-01-preview/examples/retrieve_run.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: data-plane/AzureOpenAI/inference/readme.md json: preview/2024-05-01-preview/examples/retrieve_run_step.json

️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️❌ModelValidation: 100 Errors, 0 Warnings failed [Detail]

Only 21 items are listed, please refer to log for more details.

Rule	Message
`❌` UNRESOLVABLE_REFERENCE	Reference could not be resolved: #/definitions/OperationState Url: authoring/preview/2024-05-01-preview/azureopenai.json#L2725:17
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation Completions_Create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L191:22 ExampleUrl: preview/2024-05-01-preview/examples/completions.json#L17:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation embeddings_create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L435:22 ExampleUrl: preview/2024-05-01-preview/examples/embeddings.json#L13:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation ChatCompletions_Create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L543:22 ExampleUrl: preview/2024-05-01-preview/examples/chat_completions.json#L20:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation ChatCompletions_Create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L543:22 ExampleUrl: preview/2024-05-01-preview/examples/chat_completions_azure_search_minimum.json#L28:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation ChatCompletions_Create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L543:22 ExampleUrl: preview/2024-05-01-preview/examples/chat_completions_azure_search_image_vector.json#L35:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation ChatCompletions_Create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L543:22 ExampleUrl: preview/2024-05-01-preview/examples/chat_completions_azure_search_advanced.json#L61:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation ChatCompletions_Create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L543:22 ExampleUrl: preview/2024-05-01-preview/examples/chat_completions_aml_index.json#L30:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation ChatCompletions_Create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L543:22 ExampleUrl: preview/2024-05-01-preview/examples/chat_completions_cosmos_db.json#L42:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation ChatCompletions_Create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L543:22 ExampleUrl: preview/2024-05-01-preview/examples/chat_completions_elasticsearch.json#L30:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation ChatCompletions_Create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L543:22 ExampleUrl: preview/2024-05-01-preview/examples/chat_completions_pinecone.json#L42:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation Transcriptions_Create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L645:22 ExampleUrl: preview/2024-05-01-preview/examples/audio_transcription_object.json#L8:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation Translations_Create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L716:22 ExampleUrl: preview/2024-05-01-preview/examples/audio_translation_object.json#L9:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation Speech_Create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L787:22 ExampleUrl: preview/2024-05-01-preview/examples/audio_speech.json#L13:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation ImageGenerations_Create has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L843:22 ExampleUrl: preview/2024-05-01-preview/examples/image_generation.json#L14:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation List_Assistants has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L944:22 ExampleUrl: preview/2024-05-01-preview/examples/list_assistants.json#L9:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation Create_Assistant has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L990:22 ExampleUrl: preview/2024-05-01-preview/examples/create_assistant.json#L17:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation Get_Assistant has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L1037:22 ExampleUrl: preview/2024-05-01-preview/examples/retrieve_assistant.json#L8:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation Modify_Assistant has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L1092:22 ExampleUrl: preview/2024-05-01-preview/examples/modify_assistant.json#L17:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation Delete_Assistant has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L1137:22 ExampleUrl: preview/2024-05-01-preview/examples/delete_assistant.json#L8:16
`❌` RESPONSE_SCHEMA_NOT_IN_SPEC	Response statusCode 200 for operation Create_Thread has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: inference/preview/2024-05-01-preview/inference.json#L1185:22 ExampleUrl: preview/2024-05-01-preview/examples/create_thread.json#L7:16

️❌SemanticValidation: 9 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` UNRESOLVABLE_REFERENCE	Reference could not be resolved: #/definitions/OperationState JsonUrl: authoring/preview/2024-05-01-preview/azureopenai.json#L2725:17
`❌` OBJECT_MISSING_REQUIRED_PROPERTY	Missing required property: swagger JsonUrl: inference/preview/2024-05-01-preview/inference.json
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: openapi JsonUrl: inference/preview/2024-05-01-preview/inference.json
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: servers JsonUrl: inference/preview/2024-05-01-preview/inference.json
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: components JsonUrl: inference/preview/2024-05-01-preview/inference.json
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: requestBody JsonUrl: inference/preview/2024-05-01-preview/inference.json
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: schema JsonUrl: inference/preview/2024-05-01-preview/inference.json
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: content JsonUrl: inference/preview/2024-05-01-preview/inference.json
`❌` OBJECT_MISSING_REQUIRED_PROPERTY	Missing required property: type JsonUrl: inference/preview/2024-05-01-preview/inference.json

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-05-09T00:37:59Z

Swagger Generation Artifacts

️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` RestBuild error	"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=429188&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 "

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-05-09T00:38:00Z

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

johanste · 2024-05-13T17:18:26Z

...gnitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.json

+                "default": {
+                    "description": "An error occurred.",
+                    "schema": {
+                        "$ref": "#/definitions/ErrorResponse"


Is this really using the same error contract as OAI?

@gjwoods , could you take a look?

@johanste For the ingestion APIs, we are using the same error contract as the other authoring APIs e.g. finetuning, ...etc. That's for the API-level errors. For the run-level failures, we introduced a new contract that is specific to OYD ingestion upon your and Jeffrey's suggestion (since it's returned in the payload of a successful GET request)

jpalvarezl · 2024-05-15T13:32:36Z

...gnitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.yaml

+      innerErrors:
+        type: array
+        items:
+        type: string


Sorry for commenting on a closed PR. This entity is flagged as incorrectly defined by my VS Code extension. It has 2 type keys.

@YunsongB , just @'ing you for visibility :)

* Add AOAI 2024-05-01-preview api version * Reference files in read me; * Fix swagger avacado gate; * Fix spellcheck errors; * Update cSpell.json to override expected word; --------- Co-authored-by: Yunsong Bai <[email protected]>

Add AOAI 2024-05-01-preview api version

5beb5c9

YunsongB requested a review from yangyuan as a code owner May 9, 2024 00:37

Reference files in read me;

1ae45fc

AzureRestAPISpecReview added data-plane new-api-version labels May 9, 2024

Fix swagger avacado gate;

569f141

johanste reviewed May 13, 2024

View reviewed changes

johanste approved these changes May 13, 2024

View reviewed changes

Yunsong Bai added 2 commits May 13, 2024 15:00

Fix spellcheck errors;

e7facd1

Update cSpell.json to override expected word;

8c0d7cd

lmazuel merged commit da326fe into Azure:main May 14, 2024
22 of 32 checks passed

jpalvarezl reviewed May 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add AOAI 2024-05-01-preview API version #29042

Add AOAI 2024-05-01-preview API version #29042

YunsongB commented May 9, 2024

openapi-pipeline-app bot commented May 9, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 9, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 9, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 9, 2024 •

edited

Loading

johanste May 13, 2024

YunsongB May 13, 2024

aykame May 13, 2024

jpalvarezl May 15, 2024 •

edited

Loading

jpalvarezl May 15, 2024

Add AOAI 2024-05-01-preview API version #29042

Add AOAI 2024-05-01-preview API version #29042

Conversation

YunsongB commented May 9, 2024

Data Plane API Specification Update Pull Request

PR review workflow diagram

API Info: The Basics

Change Scope

Viewing API changes

Suppressing failures

❔Got questions? Need additional info?? We are here to help!

Tooling

Guidelines & Specifications

Helpful Links

Getting help

openapi-pipeline-app bot commented May 9, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented May 9, 2024 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented May 9, 2024 • edited Loading

Swagger Generation Artifacts

openapi-pipeline-app bot commented May 9, 2024 • edited Loading

johanste May 13, 2024

Choose a reason for hiding this comment

YunsongB May 13, 2024

Choose a reason for hiding this comment

aykame May 13, 2024

Choose a reason for hiding this comment

jpalvarezl May 15, 2024 • edited Loading

Choose a reason for hiding this comment

jpalvarezl May 15, 2024

Choose a reason for hiding this comment

openapi-pipeline-app bot commented May 9, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 9, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 9, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 9, 2024 •

edited

Loading

jpalvarezl May 15, 2024 •

edited

Loading