OpenAI: TypeSpec representations of new Assistants streaming response models #28555
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Generation Artifacts
|
| Rule | Message |
|---|---|
|
"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=431088&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 " |
️❌ azure-sdk-for-net-track2 failed [Detail]
❌Failed in generating from 1694ccef63e08a6f3ddc064a359d9b5293429bd4. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json cmderr [Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:131 cmderr [Invoke-GenerateAndBuildV2.ps1] Line | cmderr [Invoke-GenerateAndBuildV2.ps1] 131 | GeneratePackage ` cmderr [Invoke-GenerateAndBuildV2.ps1] | ~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] | Failed to generate sdk. exit code: False cmderr [Invoke-GenerateAndBuildV2.ps1] Get-ChildItem: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807 cmderr [Invoke-GenerateAndBuildV2.ps1] Line | cmderr [Invoke-GenerateAndBuildV2.ps1] 807 | … rtifacts += Get-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s … cmderr [Invoke-GenerateAndBuildV2.ps1] | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] | Cannot find path cmderr [Invoke-GenerateAndBuildV2.ps1] | '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because cmderr [Invoke-GenerateAndBuildV2.ps1] | it does not exist. cmderr [Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:131 cmderr [Invoke-GenerateAndBuildV2.ps1] Line | cmderr [Invoke-GenerateAndBuildV2.ps1] 131 | GeneratePackage ` cmderr [Invoke-GenerateAndBuildV2.ps1] | ~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] | Failed to generate sdk artifact
❌Azure.AI.OpenAI.Assistants [Preview SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning in generating from 1694ccef63e08a6f3ddc064a359d9b5293429bd4. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json cmderr [generate.py] error: import-not-found - Couldn't resolve import "@azure-tools/typespec-azure-rulesets" @ unknown cmderr [generate.py] error: unknown-rule-set - Rule set "data-plane" is not found in library "@azure-tools/typespec-azure-rulesets" @ unknown
️✔️azure-ai-openai-assistants [Preview SDK Changes]- pom.xml
- azure-ai-openai-assistants-1.0.0-beta.3-sources.jar
- azure-ai-openai-assistants-1.0.0-beta.3.jar
️❌ azure-sdk-for-js failed [Detail]
❌Code Generator Failed in generating from 1694ccef63e08a6f3ddc064a359d9b5293429bd4. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json warn File azure-sdk-for-js_tmp/initOutput.json not found to read command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json cmderr [automation_generate.sh] [ERROR] Command failed: pwsh ./eng/common/scripts/TypeSpec-Project-Process.ps1 /mnt/vss/_work/1/s/azure-rest-api-specs/specification/ai/OpenAI.Assistants 1694ccef63e08a6f3ddc064a359d9b5293429bd4 https://github.com/Azure/azure-rest-api-specs cmderr [automation_generate.sh] [ERROR] Command failed: pwsh ./eng/common/scripts/TypeSpec-Project-Process.ps1 /mnt/vss/_work/1/s/azure-rest-api-specs/specification/ai/OpenAI.Assistants 1694ccef63e08a6f3ddc064a359d9b5293429bd4 https://github.com/Azure/azure-rest-api-specs error Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-js]: sh .scripts/automation_generate.sh warn Skip package processing as generation is failed
Generated ApiView
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
This was referenced Apr 2, 2024
jpalvarezl
reviewed
Apr 8, 2024
There was a problem hiding this comment.
In addition to all the comments, do you think it would be a good idea to have the enums for AssistantsStreamEvent, ThreadStreamEvent, RunStreamEvent, RunStepStreamEvent and MessageStreamEvent represented as enums defined and exposed as private & usage for the SDKs to make deserialization a bit more uniform across the generated SDKs?
jpalvarezl
reviewed
Apr 15, 2024
This was referenced Apr 16, 2024
|
Edit: confirmed this is not the case from the OpenAI swagger perspective. So please dismiss this comment. I will try to figure out how to best approach this as this seems to be a Java only issue.
the |
* Adding streaming events and modified class visibilities * Represented the alias as a union to align better with the swagger and have a class generated * Adding chunk classes to be included on code emission
jpalvarezl
reviewed
Apr 25, 2024
|
A couple more models that I noticed while doing streaming stuff: #28864 |
jpalvarezl
reviewed
May 1, 2024
* Added usage models for run and runStep * Added added annotation * Added warning suppresion for nullable fields
johanste
reviewed
May 16, 2024
…s://github.com/Azure/azure-rest-api-specs into user/travisw/assistants-streaming-models-draft
AzureRestAPISpecReview
added
new-api-version
and removed
resource-manager
ARMReview
NotReadyForARMReview
labels
johanste
reviewed
May 21, 2024
| } | ||
|
|
||
| /** Thread operation related streaming events */ | ||
| union ThreadStreamEvent { |
There was a problem hiding this comment.
This union is part of all the unions that constitute the larger union AssistantStreamEvent that represents all the possible event labels the service can send while streaming.
The spec for OpenAI looks like this:
AssistantStreamEvent:
description: |
Represents an event emitted when streaming a Run.
Each event in a server-sent events stream has an `event` and `data` property:
```
event: thread.created
data: {"id": "thread_123", "object": "thread", ...}
```
We emit events whenever a new object is created, transitions to a new state, or is being
streamed in parts (deltas)...
# removed some stuff here to make this more focused on my point
oneOf:
- $ref: "#/components/schemas/ThreadStreamEvent" # <- each one of these have their own documentation
- $ref: "#/components/schemas/RunStreamEvent"
- $ref: "#/components/schemas/RunStepStreamEvent"
- $ref: "#/components/schemas/MessageStreamEvent"
- $ref: "#/components/schemas/ErrorEvent"
- $ref: "#/components/schemas/DoneEvent"
# removed some stuff here to make this more focused on my point Each "sub-union" of AssistantStreamEvent has its own documentation for their variants and values. In a setting like Java, where we are relying on users having to cast to the correct type of message coming from the stream, this documentation provides what I think is important guidance on which type to use.
There was a problem hiding this comment.
Interesting. As currently implemented, I'm not sure if the docs for each sub-union provides much clarity, but I could see scenarios where it would.
However, if our code generators/libraries expect you to cast to the constituent union member type here, I think I would have some concerns. Wouldn't it be preferable to "flatten" the union in that case? It feels like the ergonomics of using the generated code would be harder than needed...
johanste
reviewed
May 21, 2024
johanste
approved these changes
May 23, 2024
Francisco-Gamino
pushed a commit
to Francisco-Gamino/azure-rest-api-specs
that referenced
this pull request
Jun 5, 2024
… models (Azure#28555) * initial commit for models in support of streaming Assistants calls * merge + pr feedback * [OpenAI] [Assistants] PR feedback (Azure#28786) * Adding streaming events and modified class visibilities * Represented the alias as a union to align better with the swagger and have a class generated * Adding chunk classes to be included on code emission * Update specification/ai/OpenAI.Assistants/streaming/events.tsp * Added usage models for run and runStep (Azure#28864) * Added usage models for run and runStep * Added added annotation * Added warning suppresion for nullable fields * Compiled with new models and unions * back ported everything to a past version. Extracted SubmitToolOutputsOptions model * re-compile * Removed toolresources for now and added warning supressions * Brought up to date the classes related to streaming for AssistantStreamEvent * Making filename mandatory uploadFile operation * Project compilation * Re-formated definitiones according to CI instructions * Added missing documentation * Reverted nullability of fileName * re-compiled * Removed openapi v2 and v3 files generated with the placeholder version * reformating * Maded the stream events public to expose types and docs to users * Made stream events publics * remove single-use options model, merge into route params directly * proactively add 2024-05-01-preview label * Removed 05_01 from service version enum ... for now * Added string type to AssistantStreamEvent * tsp validation check --------- Co-authored-by: Jose Alvarez <[email protected]> Co-authored-by: Jose Alvarez <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Edit by @jpalvarezl:
streamfield forcreateAndRunThread,runThreadandsubmitToolOutputsfunction calls (these need to be appropriately handled by clients to deserialize according to all the events detailed instreaming/events.tsp->AssistantStreamEvent(here is the Java implementation for reference)2024-02-15-preview), which in fact reflects the way this changes were introduced by the backend.