Fixes to Assistant, VectorStore client methods #70
Conversation
| public virtual Task<ClientResult> CreateMessageAsync(string threadId, BinaryContent content, RequestOptions options = null); | ||
| public virtual ClientResult<ThreadRun> CreateRun(AssistantThread thread, Assistant assistant, RunCreationOptions options = null); | ||
| public virtual ClientResult<ThreadRun> CreateRun(string threadId, string assistantId, RunCreationOptions options = null); | ||
| public virtual ClientResult<ThreadRun> CreateRun(AssistantThread thread, Assistant assistant, RunCreationOptions options = null, CancellationToken cancellationToken = default); |
There was a problem hiding this comment.
This is not exactly what I did in my PR. In my PR, I added cancellation tokens only to the most general/flexible overload. In case of this method, it would mean adding the CT only to the overload that takes string threadId and string assistantId. If the caller have AssistantThread and Assistant instances, they would simply call CreateRun(thread.Id, assistant.Id). In other words, I did not add CTs to helper overloads that simply delegate to other more general/flexible overloads.
There was a problem hiding this comment.
Based on our conversation offline, we have decided to remove the overloads that take complex objects (such as ThreadRun run) and keep only the ones that take plain string IDs (such as string runId) in favor of exploring the option of making these models into subclients. For example, rather than having AssistantClient.CancelRun(ThreadRun run), we could instead have ThreadRun.Cancel().
With these overloads gone, Kryzsztof's concern here will be addressed too.
| @@ -879,6 +890,7 @@ namespace OpenAI.Chat { | |||
| public ChatFunctionCall FunctionCall { get; init; } | |||
| public string ParticipantName { get; init; } | |||
| public IList<ChatToolCall> ToolCalls { get; } | |||
| protected override void WriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options); | |||
There was a problem hiding this comment.
This file needs to be regenerated before merging.
AssistantClientandVectorStoreClienthave optionalCancellationTokens added as method parameters, including the typed instance convenience overloads[EditorBrowsable(EditorBrowsableState.Never)]attributes toAssistantClientprotocol methods, improving strongly typed convenience method discoverabilitymax_num_resultsproperty forfile_searchnot being serialized/deserialized