[OpenAI] system_fingerprint is optional #26993

deyaaeldeen · 2023-12-07T17:56:08Z

See OAI spec: https://github.com/openai/openai-openapi/blob/master/openapi.yaml#L5562

Data Plane API - Pull Request

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
Open API Hub

Guidelines & Specifications

Helpful Links

Azure DevTools Wiki

Checks stuck in `queued` state?

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.

openapi-pipeline-app · 2023-12-07T17:56:11Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ The required check named Swagger ModelValidation has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.

openapi-pipeline-app · 2023-12-07T17:56:12Z

Swagger Validation Report

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

compared swaggers (via Oad v0.10.4)]	new version	base version
generated.json	2023-12-01-preview(7c588eb)	2023-12-01-preview(main)

Rule	Message
`❌` 1025 - RequiredStatusChange	The 'required' status changed from the old version('True') to the new version('False'). New: inference/preview/2023-12-01-preview/generated.json#L1616:7 Old: inference/preview/2023-12-01-preview/generated.json#L1616:7

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

compared tags (via openapi-validator v2.1.6)	new version	base version
default	default(7c588eb)	default(main)

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

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

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

Rule	Message
`❌` INVALID_TYPE	Expected type object but found type string Url: inference/preview/2023-12-01-preview/generated.json#L671:34 ExampleUrl: preview/2023-12-01-preview/examples/audio_transcription_text.json#L8:13
`❌` RESPONSE_BODY_NOT_IN_EXAMPLE	Response statusCode 200 for operation GetAudioTranscriptionAsPlainText has no response body provided in the example, however the response does have a "schema" defined in the swagger spec. Url: inference/preview/2023-12-01-preview/generated.json#L86:22 ExampleUrl: preview/2023-12-01-preview/examples/audio_transcription_text.json#L10:16
`❌` INVALID_TYPE	Expected type object but found type string Url: inference/preview/2023-12-01-preview/generated.json#L859:32 ExampleUrl: preview/2023-12-01-preview/examples/audio_translation_text.json#L8:13
`❌` RESPONSE_BODY_NOT_IN_EXAMPLE	Response statusCode 200 for operation GetAudioTranslationAsPlainText has no response body provided in the example, however the response does have a "schema" defined in the swagger spec. Url: inference/preview/2023-12-01-preview/generated.json#L137:22 ExampleUrl: preview/2023-12-01-preview/examples/audio_translation_text.json#L10:16
`❌` INVALID_FORMAT	Object didn't pass validation for format uri: {search endpoint} Url: inference/preview/2023-12-01-preview/generated.json#L1196:21 ExampleUrl: preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_minimum.json#L8:13
`❌` INVALID_FORMAT	Object didn't pass validation for format uri: {search endpoint} Url: inference/preview/2023-12-01-preview/generated.json#L1196:21 ExampleUrl: preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_image_vector.json#L8:13
`❌` INVALID_FORMAT	Object didn't pass validation for format uri: {search endpoint} Url: inference/preview/2023-12-01-preview/generated.json#L1196:21 ExampleUrl: preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_advanced.json#L8:13
`❌` INVALID_FORMAT	Object didn't pass validation for format uri: {search endpoint} Url: inference/preview/2023-12-01-preview/generated.json#L2656:21 ExampleUrl: preview/2023-12-01-preview/examples/extensions_chat_completions_elasticsearch.json#L8:13
`❌` OBJECT_MISSING_REQUIRED_PROPERTY	Missing required property: key Url: inference/preview/2023-12-01-preview/generated.json#L3088:46 ExampleUrl: preview/2023-12-01-preview/examples/extensions_chat_completions_pinecone.json#L8:13
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: apiKey Url: inference/preview/2023-12-01-preview/generated.json#L3088:46 ExampleUrl: preview/2023-12-01-preview/examples/extensions_chat_completions_pinecone.json#L8:13
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: revised_prompt Url: inference/preview/2023-12-01-preview/generated.json#L3013:25 ExampleUrl: preview/2023-12-01-preview/examples/image_generation.json#L27:27
`❌` REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND	In operation GetAudioTranscriptionAsResponseObject, parameter file is required in the swagger spec but is not present in the provided example parameter values. Url: inference/preview/2023-12-01-preview/generated.json#L440:15 ExampleUrl: preview/2023-12-01-preview/examples/audio_transcription_object.json
`❌` REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND	In operation GetAudioTranslationAsResponseObject, parameter file is required in the swagger spec but is not present in the provided example parameter values. Url: inference/preview/2023-12-01-preview/generated.json#L507:15 ExampleUrl: preview/2023-12-01-preview/examples/audio_translation_object.json

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️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 · 2023-12-07T17:56:13Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 5f7c69cb0b23a3aea0adcd244009765e4bb0bbeb. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
warn		specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.AI.OpenAI [View full logs] [Preview SDK Changes]
- Azure.AI.OpenAI.1.0.0-alpha.20231207.1.nupkg
```
info	[Changelog]
```

️❌ azure-sdk-for-java failed [Detail]

❌Pipeline Framework Failed [Logs] Generate from 5f7c69cb0b23a3aea0adcd244009765e4bb0bbeb. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.1
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.1
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
warn		specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md skipped due to azure-sdk-for-java not found in swagger-to-sdk
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py]  EBADENGINE Unsupported engine {
cmderr	[generate.py] npm WARN EBADENGINE   package: '@typespec/compiler@0.51.0',
cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[generate.py] npm WARN EBADENGINE }
cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
cmderr	[generate.py] npm WARN EBADENGINE   package: '@typespec/rest@0.51.0',
cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[generate.py] npm WARN EBADENGINE }
cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
cmderr	[generate.py] npm WARN EBADENGINE   package: '@typespec/http@0.51.0',
cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[generate.py] npm WARN EBADENGINE }
cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
cmderr	[generate.py] npm WARN EBADENGINE   package: '@typespec/openapi@0.51.0',
cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[generate.py] npm WARN EBADENGINE }
cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
cmderr	[generate.py] npm WARN EBADENGINE   package: '@typespec/versioning@0.51.0',
cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[generate.py] npm WARN EBADENGINE }
cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
cmderr	[generate.py] npm WARN EBADENGINE   package: '@azure-tools/typespec-azure-core@0.37.0',
cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[generate.py] npm WARN EBADENGINE }
cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
cmderr	[generate.py] npm WARN EBADENGINE   package: '@azure-tools/typespec-client-generator-core@0.37.0',
cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[generate.py] npm WARN EBADENGINE }
cmderr	[generate.py] npm notice
cmderr	[generate.py] npm notice New major version of npm available! 8.19.4 -> 10.2.5
cmderr	[generate.py] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.5>
cmderr	[generate.py] npm notice Run `npm install -g npm@10.2.5` to update!
cmderr	[generate.py] npm notice
cmderr	[generate.py] java.lang.RuntimeException: Failed to complete postprocessing.
cmderr	[generate.py] 	at com.azure.autorest.postprocessor.Postprocessor.postProcess(Postprocessor.java:109)
cmderr	[generate.py] 	at com.azure.typespec.Main.handleDPG(Main.java:138)
cmderr	[generate.py] 	at com.azure.typespec.Main.main(Main.java:90)
cmderr	[generate.py] Caused by: java.lang.RuntimeException: Unable to complete customization
cmderr	[generate.py] 	at com.azure.autorest.postprocessor.Postprocessor.postProcess(Postprocessor.java:102)
cmderr	[generate.py] 	... 2 more
cmderr	[generate.py] Caused by: java.lang.NullPointerException
cmderr	[generate.py] 	at com.azure.autorest.postprocessor.Postprocessor.postProcess(Postprocessor.java:97)
cmderr	[generate.py] 	... 2 more
cmderr	[generate.py] Emitter "@azure-tools/typespec-java" crashed! This is a bug.
cmderr	[generate.py] Please file an issue at https://github.com/Azure/autorest.java/issues
cmderr	[generate.py] Error: JAR ended with code '1'.
cmderr	[generate.py]     at ChildProcess.<anonymous> (file:///mnt/vss/_work/1/s/azure-sdk-for-java/sdk/openai/azure-ai-openai/TempTypeSpecFiles/OpenAI.Inference/node_modules/@azure-tools/typespec-java/dist/src/emitter.js:106:37)
cmderr	[generate.py]     at ChildProcess.emit (node:events:513:28)
cmderr	[generate.py]     at Process.ChildProcess._handle.onexit (node:internal/child_process:293:12)
cmderr	[generate.py] --------------------------------------------------
cmderr	[generate.py] Library Version                0.11.3
cmderr	[generate.py] TypeSpec Compiler Version      0.51.0
cmderr	[generate.py] --------------------------------------------------
cmderr	[generate.py] �[31;1mWrite-Error: �[31;1mFailed to generate sdk project at /mnt/vss/_work/1/s/azure-sdk-for-java/sdk/openai/azure-ai-openai�[0m
error	Fatal error: The "path" argument must be of type string. Received undefined
The "path" argument must be of type string. Received undefined
TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received undefined
    at new NodeError (node:internal/errors:387:5)
    at validateString (node:internal/validators:162:11)
    at Object.basename (node:path:1309:5)
    at Object.exports.getPackageData (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/types/PackageData.js:38:82)
    at /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:210:194
    at Array.map (<anonymous>)
    at workflowHandleReadmeMdOrTypeSpecProject (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:210:164)
    at processTicksAndRejections (node:internal/process/task_queues:96:5)
    at async Object.exports.workflowMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:98:13)
    at async Object.exports.sdkAutoMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:211:13)
    at async /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18

️🔄 azure-sdk-for-js inProgress [Detail]

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

openapi-pipeline-app · 2023-12-07T17:56:14Z

Generated ApiView

Language	Package Name	ApiView Link
.Net	Azure.AI.OpenAI	There is no API change compared with the previous version
TypeSpec	OpenAI.Inference	https://apiview.dev/Assemblies/Review/ebfc3988abc84497a7d46a9a27b9fcca

[OpenAI] system_fingerprint is optional

7c588eb

deyaaeldeen requested a review from trrwilson December 7, 2023 17:56

deyaaeldeen requested a review from yangyuan as a code owner December 7, 2023 17:56

openapi-assignment-bot bot assigned lmazuel Dec 7, 2023

AzureRestAPISpecReview added data-plane TypeSpec Authored with TypeSpec labels Dec 7, 2023

azure-sdk mentioned this pull request Dec 7, 2023

[AutoPR Azure.AI.OpenAI] [OpenAI] system_fingerprint is optional azure-sdk/azure-sdk-for-net#6471

Closed

joseharriaga approved these changes Dec 8, 2023

View reviewed changes

mssfang approved these changes Dec 8, 2023

View reviewed changes

trrwilson approved these changes Dec 8, 2023

View reviewed changes

lmazuel merged commit b93d087 into main Dec 11, 2023
25 of 30 checks passed

lmazuel deleted the openai/optional-fingerprint branch December 11, 2023 22:39

arifibrahim4 pushed a commit that referenced this pull request Feb 26, 2024

[OpenAI] system_fingerprint is optional (#26993)

679039d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[OpenAI] system_fingerprint is optional #26993

[OpenAI] system_fingerprint is optional #26993

deyaaeldeen commented Dec 7, 2023

openapi-pipeline-app bot commented Dec 7, 2023 •

edited

Loading

openapi-pipeline-app bot commented Dec 7, 2023 •

edited

Loading

openapi-pipeline-app bot commented Dec 7, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Dec 7, 2023 •

edited

Loading

[OpenAI] system_fingerprint is optional #26993

[OpenAI] system_fingerprint is optional #26993

Conversation

deyaaeldeen commented Dec 7, 2023

Data Plane API - Pull Request

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

openapi-pipeline-app bot commented Dec 7, 2023 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Dec 7, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Dec 7, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Dec 7, 2023 • edited Loading

Generated ApiView

openapi-pipeline-app bot commented Dec 7, 2023 •

edited

Loading

openapi-pipeline-app bot commented Dec 7, 2023 •

edited

Loading

openapi-pipeline-app bot commented Dec 7, 2023 •

edited

Loading

openapi-pipeline-app bot commented Dec 7, 2023 •

edited

Loading