Update long-running operation APIs to use LRO subclient pattern #129
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
… using general helpers
… using general helpers
…avor of generalized helpers
…s an abstract type
annelo-msft
commented
Jul 24, 2024
| string threadId, | ||
| string assistantId, | ||
| RunCreationOptions options = null, | ||
| public virtual async Task<RunOperation> ContinueRunAsync( |
There was a problem hiding this comment.
Instead of adding a new method group here, add a factory method to RunOperation to rehydrate it, similar to Azure.Core Operation static Rehydrate method.
annelo-msft
commented
Jul 26, 2024
| @@ -433,13 +434,20 @@ public virtual ClientResult RemoveFileFromStore(string vectorStoreId, string fil | |||
| /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception> | |||
| /// <returns> The response returned from the service. </returns> | |||
| [EditorBrowsable(EditorBrowsableState.Never)] | |||
| public virtual async Task<ClientResult> CreateBatchFileJobAsync(string vectorStoreId, BinaryContent content, RequestOptions options = null) | |||
| public virtual async Task<VectorStoreFileBatchOperation> CreateBatchFileJobAsync(string vectorStoreId, BinaryContent content, RequestOptions options = null) | |||
There was a problem hiding this comment.
Need to decide if this should take ReturnWhen
annelo-msft
commented
Jul 26, 2024
| @@ -34,12 +35,18 @@ public partial class FineTuningClient | |||
| /// <exception cref="ArgumentNullException"> <paramref name="content"/> is null. </exception> | |||
| /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception> | |||
| /// <returns> The response returned from the service. </returns> | |||
| public virtual async Task<ClientResult> CreateJobAsync(BinaryContent content, RequestOptions options = null) | |||
| public virtual async Task<FineTuningOperation> CreateJobAsync(BinaryContent content, RequestOptions options = null) | |||
There was a problem hiding this comment.
Need to decide if this should take ReturnWhen
annelo-msft
commented
Jul 26, 2024
| public virtual Task<ClientResult> CreateRunAsync(string threadId, BinaryContent content, RequestOptions options = null) | ||
| => _runSubClient.CreateRunAsync(threadId, content, options); | ||
| public virtual async Task<RunOperation> CreateThreadAndRunAsync( | ||
| ReturnWhen returnWhen, |
There was a problem hiding this comment.
These should not take ReturnWhen since this LRO can be suspended and resumed -- passing ReturnWhen.Completed would be an error.
annelo-msft
commented
Jul 26, 2024
| _interval = interval ?? new TimeSpan(DefaultWaitMilliseconds); | ||
| } | ||
|
|
||
| public async Task WaitAsync(CancellationToken cancellationToken) |
There was a problem hiding this comment.
Should respect Retry-After header, and possibly exponential backoff?
annelo-msft
commented
Jul 26, 2024
| /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception> | ||
| /// <returns> The response returned from the service. </returns> | ||
| public virtual async Task<ClientResult> CreateBatchAsync(BinaryContent content, RequestOptions options = null) | ||
| public virtual async Task<BatchOperation> CreateBatchAsync(BinaryContent content, RequestOptions options = null) |
There was a problem hiding this comment.
Decide if it should take ReturnWhen parameter
annelo-msft
commented
Jul 26, 2024
| Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OpenAI.Tests", "tests\OpenAI.Tests.csproj", "{6F156401-2544-41D7-B204-3148C51C1D09}" | ||
| Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenAI.Tests", "tests\OpenAI.Tests.csproj", "{6F156401-2544-41D7-B204-3148C51C1D09}" | ||
| EndProject | ||
| Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "System.ClientModel", "..\azure-sdk-for-net\sdk\core\System.ClientModel\src\System.ClientModel.csproj", "{8316F2D5-21A7-468B-97DB-B14C44B4F50C}" |
There was a problem hiding this comment.
Should be able to update this to SCM 1.1.0-beta.6 when it ships next week.
|
Closing in favor of #156 |
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.
Currently prototype work-in-progress.
Uses SCM LRO types introduced in Azure/azure-sdk-for-net#44728
This version explores whether we can generate the LRO update mechanism as an internal update enumerator, to represent both streaming and polling versions with the same abstraction.