From 528f6c4b53bb836d40f5457fa8e78fda1bf4ecbf Mon Sep 17 00:00:00 2001 From: ballerina-bot Date: Mon, 19 May 2025 05:01:12 +0000 Subject: [PATCH] [AUTOMATED] Client Regeneration --- ballerina/client.bal | 348 +++++++++++++++++++++---------------------- ballerina/types.bal | 28 ++++ 2 files changed, 202 insertions(+), 174 deletions(-) diff --git a/ballerina/client.bal b/ballerina/client.bal index 0342651..592deea 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -26,9 +26,9 @@ public isolated client class Client { final http:Client clientEp; # Gets invoked to initialize the `connector`. # - # + config - The configurations to be used when initializing the `connector` - # + serviceUrl - URL of the target service - # + return - An error if connector initialization failed + # + config - The configurations to be used when initializing the `connector` + # + serviceUrl - URL of the target service + # + return - An error if connector initialization failed public isolated function init(ConnectionConfig config, string serviceUrl = "https://api.openai.com/v1") returns error? { http:ClientConfiguration httpClientConfig = {auth: config.auth, httpVersion: config.httpVersion, http1Settings: config.http1Settings, http2Settings: config.http2Settings, timeout: config.timeout, forwarded: config.forwarded, followRedirects: config.followRedirects, poolConfig: config.poolConfig, cache: config.cache, compression: config.compression, circuitBreaker: config.circuitBreaker, retryConfig: config.retryConfig, cookieConfig: config.cookieConfig, responseLimits: config.responseLimits, secureSocket: config.secureSocket, proxy: config.proxy, socketConfig: config.socketConfig, validation: config.validation, laxDataBinding: config.laxDataBinding}; self.clientEp = check new (serviceUrl, httpClientConfig); @@ -36,8 +36,8 @@ public isolated client class Client { # Creates a model response for the given chat conversation. # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post chat/completions(CreateChatCompletionRequest payload, map headers = {}) returns CreateChatCompletionResponse|error { string resourcePath = string `/chat/completions`; http:Request request = new; @@ -48,8 +48,8 @@ public isolated client class Client { # Creates a completion for the provided prompt and parameters. # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post completions(CreateCompletionRequest payload, map headers = {}) returns CreateCompletionResponse|error { string resourcePath = string `/completions`; http:Request request = new; @@ -60,8 +60,8 @@ public isolated client class Client { # Creates an image given a prompt. # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post images/generations(CreateImageRequest payload, map headers = {}) returns ImagesResponse|error { string resourcePath = string `/images/generations`; http:Request request = new; @@ -72,32 +72,32 @@ public isolated client class Client { # Creates an edited or extended image given an original image and a prompt. # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post images/edits(CreateImageEditRequest payload, map headers = {}) returns ImagesResponse|error { string resourcePath = string `/images/edits`; http:Request request = new; - mime:Entity[] bodyParts = check createBodyParts(payload); + mime:Entity[] bodyParts = check createBodyParts(check jsondata:toJson(payload).ensureType()); request.setBodyParts(bodyParts); return self.clientEp->post(resourcePath, request, headers); } # Creates a variation of a given image. # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post images/variations(CreateImageVariationRequest payload, map headers = {}) returns ImagesResponse|error { string resourcePath = string `/images/variations`; http:Request request = new; - mime:Entity[] bodyParts = check createBodyParts(payload); + mime:Entity[] bodyParts = check createBodyParts(check jsondata:toJson(payload).ensureType()); request.setBodyParts(bodyParts); return self.clientEp->post(resourcePath, request, headers); } # Creates an embedding vector representing the input text. # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post embeddings(CreateEmbeddingRequest payload, map headers = {}) returns CreateEmbeddingResponse|error { string resourcePath = string `/embeddings`; http:Request request = new; @@ -108,8 +108,8 @@ public isolated client class Client { # Generates audio from the input text. # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post audio/speech(CreateSpeechRequest payload, map headers = {}) returns byte[]|error { string resourcePath = string `/audio/speech`; http:Request request = new; @@ -120,33 +120,33 @@ public isolated client class Client { # Transcribes audio into the input language. # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post audio/transcriptions(CreateTranscriptionRequest payload, map headers = {}) returns InlineResponse200|error { string resourcePath = string `/audio/transcriptions`; http:Request request = new; - mime:Entity[] bodyParts = check createBodyParts(payload); + mime:Entity[] bodyParts = check createBodyParts(check jsondata:toJson(payload).ensureType()); request.setBodyParts(bodyParts); return self.clientEp->post(resourcePath, request, headers); } # Translates audio into English. # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post audio/translations(CreateTranslationRequest payload, map headers = {}) returns InlineResponse2001|error { string resourcePath = string `/audio/translations`; http:Request request = new; - mime:Entity[] bodyParts = check createBodyParts(payload); + mime:Entity[] bodyParts = check createBodyParts(check jsondata:toJson(payload).ensureType()); request.setBodyParts(bodyParts); return self.clientEp->post(resourcePath, request, headers); } # Returns a list of files that belong to the user's organization. # - # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - OK resource isolated function get files(map headers = {}, *ListFilesQueries queries) returns ListFilesResponse|error { string resourcePath = string `/files`; resourcePath = resourcePath + check getPathForQueryParam(queries); @@ -154,21 +154,21 @@ public isolated client class Client { } # Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and the size of all files uploaded by one organization can be up to 100 GB. - # + # # The Assistants API supports files up to 2 million tokens and of specific file types. See the [Assistants Tools guide](/docs/assistants/tools) for details. - # + # # The Fine-tuning API only supports `.jsonl` files. The input also has certain required formats for fine-tuning [chat](/docs/api-reference/fine-tuning/chat-input) or [completions](/docs/api-reference/fine-tuning/completions-input) models. - # + # # The Batch API only supports `.jsonl` files up to 100 MB in size. The input also has a specific required [format](/docs/api-reference/batch/request-input). - # + # # Please [contact us](https://help.openai.com/) if you need to increase these storage limits. # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post files(CreateFileRequest payload, map headers = {}) returns OpenAIFile|error { string resourcePath = string `/files`; http:Request request = new; - mime:Entity[] bodyParts = check createBodyParts(payload); + mime:Entity[] bodyParts = check createBodyParts(check jsondata:toJson(payload).ensureType()); request.setBodyParts(bodyParts); return self.clientEp->post(resourcePath, request, headers); } @@ -176,8 +176,8 @@ public isolated client class Client { # Returns information about a specific file. # # + fileId - The ID of the file to use for this request - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function get files/[string fileId](map headers = {}) returns OpenAIFile|error { string resourcePath = string `/files/${getEncodedUri(fileId)}`; return self.clientEp->get(resourcePath, headers); @@ -186,8 +186,8 @@ public isolated client class Client { # Delete a file. # # + fileId - The ID of the file to use for this request - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function delete files/[string fileId](map headers = {}) returns DeleteFileResponse|error { string resourcePath = string `/files/${getEncodedUri(fileId)}`; return self.clientEp->delete(resourcePath, headers = headers); @@ -196,24 +196,24 @@ public isolated client class Client { # Returns the contents of the specified file. # # + fileId - The ID of the file to use for this request - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function get files/[string fileId]/content(map headers = {}) returns byte[]|error { string resourcePath = string `/files/${getEncodedUri(fileId)}/content`; return self.clientEp->get(resourcePath, headers); } # Creates an intermediate [Upload](/docs/api-reference/uploads/object) object that you can add [Parts](/docs/api-reference/uploads/part-object) to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it. - # + # # Once you complete the Upload, we will create a [File](/docs/api-reference/files/object) object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object. - # + # # For certain `purpose`s, the correct `mime_type` must be specified. Please refer to documentation for the supported MIME types for your use case: # - [Assistants](/docs/assistants/tools/file-search/supported-files) - # + # # For guidance on the proper filename extensions for each purpose, please follow the documentation on [creating a File](/docs/api-reference/files/create). # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post uploads(CreateUploadRequest payload, map headers = {}) returns Upload|error { string resourcePath = string `/uploads`; http:Request request = new; @@ -222,34 +222,34 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - # Adds a [Part](/docs/api-reference/uploads/part-object) to an [Upload](/docs/api-reference/uploads/object) object. A Part represents a chunk of bytes from the file you are trying to upload. - # + # Adds a [Part](/docs/api-reference/uploads/part-object) to an [Upload](/docs/api-reference/uploads/object) object. A Part represents a chunk of bytes from the file you are trying to upload. + # # Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB. - # + # # It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you [complete the Upload](/docs/api-reference/uploads/complete). # # + uploadId - The ID of the Upload - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post uploads/[string uploadId]/parts(AddUploadPartRequest payload, map headers = {}) returns UploadPart|error { string resourcePath = string `/uploads/${getEncodedUri(uploadId)}/parts`; http:Request request = new; - mime:Entity[] bodyParts = check createBodyParts(payload); + mime:Entity[] bodyParts = check createBodyParts(check jsondata:toJson(payload).ensureType()); request.setBodyParts(bodyParts); return self.clientEp->post(resourcePath, request, headers); } - # Completes the [Upload](/docs/api-reference/uploads/object). - # + # Completes the [Upload](/docs/api-reference/uploads/object). + # # Within the returned Upload object, there is a nested [File](/docs/api-reference/files/object) object that is ready to use in the rest of the platform. - # + # # You can specify the order of the Parts by passing in an ordered list of the Part IDs. - # + # # The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed. # # + uploadId - The ID of the Upload - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post uploads/[string uploadId]/complete(CompleteUploadRequest payload, map headers = {}) returns Upload|error { string resourcePath = string `/uploads/${getEncodedUri(uploadId)}/complete`; http:Request request = new; @@ -261,8 +261,8 @@ public isolated client class Client { # Cancels the Upload. No Parts may be added after an Upload is cancelled. # # + uploadId - The ID of the Upload - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post uploads/[string uploadId]/cancel(map headers = {}) returns Upload|error { string resourcePath = string `/uploads/${getEncodedUri(uploadId)}/cancel`; http:Request request = new; @@ -271,9 +271,9 @@ public isolated client class Client { # List your organization's fine-tuning jobs # - # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - OK resource isolated function get fine_tuning/jobs(map headers = {}, *ListPaginatedFineTuningJobsQueries queries) returns ListPaginatedFineTuningJobsResponse|error { string resourcePath = string `/fine_tuning/jobs`; resourcePath = resourcePath + check getPathForQueryParam(queries); @@ -281,13 +281,13 @@ public isolated client class Client { } # Creates a fine-tuning job which begins the process of creating a new model from a given dataset. - # + # # Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. - # + # # [Learn more about fine-tuning](/docs/guides/fine-tuning) # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post fine_tuning/jobs(CreateFineTuningJobRequest payload, map headers = {}) returns FineTuningJob|error { string resourcePath = string `/fine_tuning/jobs`; http:Request request = new; @@ -297,12 +297,12 @@ public isolated client class Client { } # Get info about a fine-tuning job. - # + # # [Learn more about fine-tuning](/docs/guides/fine-tuning) # # + fineTuningJobId - The ID of the fine-tuning job - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function get fine_tuning/jobs/[string fineTuningJobId](map headers = {}) returns FineTuningJob|error { string resourcePath = string `/fine_tuning/jobs/${getEncodedUri(fineTuningJobId)}`; return self.clientEp->get(resourcePath, headers); @@ -311,9 +311,9 @@ public isolated client class Client { # Get status updates for a fine-tuning job. # # + fineTuningJobId - The ID of the fine-tuning job to get events for - # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - OK resource isolated function get fine_tuning/jobs/[string fineTuningJobId]/events(map headers = {}, *ListFineTuningEventsQueries queries) returns ListFineTuningJobEventsResponse|error { string resourcePath = string `/fine_tuning/jobs/${getEncodedUri(fineTuningJobId)}/events`; resourcePath = resourcePath + check getPathForQueryParam(queries); @@ -323,8 +323,8 @@ public isolated client class Client { # Immediately cancel a fine-tune job. # # + fineTuningJobId - The ID of the fine-tuning job to cancel - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post fine_tuning/jobs/[string fineTuningJobId]/cancel(map headers = {}) returns FineTuningJob|error { string resourcePath = string `/fine_tuning/jobs/${getEncodedUri(fineTuningJobId)}/cancel`; http:Request request = new; @@ -334,9 +334,9 @@ public isolated client class Client { # List checkpoints for a fine-tuning job. # # + fineTuningJobId - The ID of the fine-tuning job to get checkpoints for - # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - OK resource isolated function get fine_tuning/jobs/[string fineTuningJobId]/checkpoints(map headers = {}, *ListFineTuningJobCheckpointsQueries queries) returns ListFineTuningJobCheckpointsResponse|error { string resourcePath = string `/fine_tuning/jobs/${getEncodedUri(fineTuningJobId)}/checkpoints`; resourcePath = resourcePath + check getPathForQueryParam(queries); @@ -345,8 +345,8 @@ public isolated client class Client { # Lists the currently available models, and provides basic information about each one such as the owner and availability. # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function get models(map headers = {}) returns ListModelsResponse|error { string resourcePath = string `/models`; return self.clientEp->get(resourcePath, headers); @@ -355,8 +355,8 @@ public isolated client class Client { # Retrieves a model instance, providing basic information about the model such as the owner and permissioning. # # + model - The ID of the model to use for this request - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function get models/[string model](map headers = {}) returns Model|error { string resourcePath = string `/models/${getEncodedUri(model)}`; return self.clientEp->get(resourcePath, headers); @@ -365,8 +365,8 @@ public isolated client class Client { # Delete a fine-tuned model. You must have the Owner role in your organization to delete a model. # # + model - The model to delete - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function delete models/[string model](map headers = {}) returns DeleteModelResponse|error { string resourcePath = string `/models/${getEncodedUri(model)}`; return self.clientEp->delete(resourcePath, headers = headers); @@ -374,8 +374,8 @@ public isolated client class Client { # Classifies if text is potentially harmful. # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post moderations(CreateModerationRequest payload, map headers = {}) returns CreateModerationResponse|error { string resourcePath = string `/moderations`; http:Request request = new; @@ -386,9 +386,9 @@ public isolated client class Client { # Returns a list of assistants. # - # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - OK resource isolated function get assistants(map headers = {}, *ListAssistantsQueries queries) returns ListAssistantsResponse|error { string resourcePath = string `/assistants`; resourcePath = resourcePath + check getPathForQueryParam(queries); @@ -397,8 +397,8 @@ public isolated client class Client { # Create an assistant with a model and instructions. # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post assistants(CreateAssistantRequest payload, map headers = {}) returns AssistantObject|error { string resourcePath = string `/assistants`; http:Request request = new; @@ -410,8 +410,8 @@ public isolated client class Client { # Retrieves an assistant. # # + assistantId - The ID of the assistant to retrieve - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function get assistants/[string assistantId](map headers = {}) returns AssistantObject|error { string resourcePath = string `/assistants/${getEncodedUri(assistantId)}`; return self.clientEp->get(resourcePath, headers); @@ -420,8 +420,8 @@ public isolated client class Client { # Modifies an assistant. # # + assistantId - The ID of the assistant to modify - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post assistants/[string assistantId](ModifyAssistantRequest payload, map headers = {}) returns AssistantObject|error { string resourcePath = string `/assistants/${getEncodedUri(assistantId)}`; http:Request request = new; @@ -433,8 +433,8 @@ public isolated client class Client { # Delete an assistant. # # + assistantId - The ID of the assistant to delete - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function delete assistants/[string assistantId](map headers = {}) returns DeleteAssistantResponse|error { string resourcePath = string `/assistants/${getEncodedUri(assistantId)}`; return self.clientEp->delete(resourcePath, headers = headers); @@ -442,8 +442,8 @@ public isolated client class Client { # Create a thread. # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post threads(CreateThreadRequest payload, map headers = {}) returns ThreadObject|error { string resourcePath = string `/threads`; http:Request request = new; @@ -455,8 +455,8 @@ public isolated client class Client { # Retrieves a thread. # # + threadId - The ID of the thread to retrieve - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function get threads/[string threadId](map headers = {}) returns ThreadObject|error { string resourcePath = string `/threads/${getEncodedUri(threadId)}`; return self.clientEp->get(resourcePath, headers); @@ -465,8 +465,8 @@ public isolated client class Client { # Modifies a thread. # # + threadId - The ID of the thread to modify. Only the `metadata` can be modified - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post threads/[string threadId](ModifyThreadRequest payload, map headers = {}) returns ThreadObject|error { string resourcePath = string `/threads/${getEncodedUri(threadId)}`; http:Request request = new; @@ -478,8 +478,8 @@ public isolated client class Client { # Delete a thread. # # + threadId - The ID of the thread to delete - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function delete threads/[string threadId](map headers = {}) returns DeleteThreadResponse|error { string resourcePath = string `/threads/${getEncodedUri(threadId)}`; return self.clientEp->delete(resourcePath, headers = headers); @@ -488,9 +488,9 @@ public isolated client class Client { # Returns a list of messages for a given thread. # # + threadId - The ID of the [thread](/docs/api-reference/threads) the messages belong to - # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - OK resource isolated function get threads/[string threadId]/messages(map headers = {}, *ListMessagesQueries queries) returns ListMessagesResponse|error { string resourcePath = string `/threads/${getEncodedUri(threadId)}/messages`; resourcePath = resourcePath + check getPathForQueryParam(queries); @@ -500,8 +500,8 @@ public isolated client class Client { # Create a message. # # + threadId - The ID of the [thread](/docs/api-reference/threads) to create a message for - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post threads/[string threadId]/messages(CreateMessageRequest payload, map headers = {}) returns MessageObject|error { string resourcePath = string `/threads/${getEncodedUri(threadId)}/messages`; http:Request request = new; @@ -514,8 +514,8 @@ public isolated client class Client { # # + threadId - The ID of the [thread](/docs/api-reference/threads) to which this message belongs # + messageId - The ID of the message to retrieve - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function get threads/[string threadId]/messages/[string messageId](map headers = {}) returns MessageObject|error { string resourcePath = string `/threads/${getEncodedUri(threadId)}/messages/${getEncodedUri(messageId)}`; return self.clientEp->get(resourcePath, headers); @@ -525,8 +525,8 @@ public isolated client class Client { # # + threadId - The ID of the thread to which this message belongs # + messageId - The ID of the message to modify - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post threads/[string threadId]/messages/[string messageId](ModifyMessageRequest payload, map headers = {}) returns MessageObject|error { string resourcePath = string `/threads/${getEncodedUri(threadId)}/messages/${getEncodedUri(messageId)}`; http:Request request = new; @@ -539,8 +539,8 @@ public isolated client class Client { # # + threadId - The ID of the thread to which this message belongs # + messageId - The ID of the message to delete - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function delete threads/[string threadId]/messages/[string messageId](map headers = {}) returns DeleteMessageResponse|error { string resourcePath = string `/threads/${getEncodedUri(threadId)}/messages/${getEncodedUri(messageId)}`; return self.clientEp->delete(resourcePath, headers = headers); @@ -548,8 +548,8 @@ public isolated client class Client { # Create a thread and run it in one request. # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post threads/runs(CreateThreadAndRunRequest payload, map headers = {}) returns RunObject|error { string resourcePath = string `/threads/runs`; http:Request request = new; @@ -561,9 +561,9 @@ public isolated client class Client { # Returns a list of runs belonging to a thread. # # + threadId - The ID of the thread the run belongs to - # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - OK resource isolated function get threads/[string threadId]/runs(map headers = {}, *ListRunsQueries queries) returns ListRunsResponse|error { string resourcePath = string `/threads/${getEncodedUri(threadId)}/runs`; resourcePath = resourcePath + check getPathForQueryParam(queries); @@ -573,8 +573,8 @@ public isolated client class Client { # Create a run. # # + threadId - The ID of the thread to run - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post threads/[string threadId]/runs(CreateRunRequest payload, map headers = {}) returns RunObject|error { string resourcePath = string `/threads/${getEncodedUri(threadId)}/runs`; http:Request request = new; @@ -587,8 +587,8 @@ public isolated client class Client { # # + threadId - The ID of the [thread](/docs/api-reference/threads) that was run # + runId - The ID of the run to retrieve - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function get threads/[string threadId]/runs/[string runId](map headers = {}) returns RunObject|error { string resourcePath = string `/threads/${getEncodedUri(threadId)}/runs/${getEncodedUri(runId)}`; return self.clientEp->get(resourcePath, headers); @@ -598,8 +598,8 @@ public isolated client class Client { # # + threadId - The ID of the [thread](/docs/api-reference/threads) that was run # + runId - The ID of the run to modify - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post threads/[string threadId]/runs/[string runId](ModifyRunRequest payload, map headers = {}) returns RunObject|error { string resourcePath = string `/threads/${getEncodedUri(threadId)}/runs/${getEncodedUri(runId)}`; http:Request request = new; @@ -612,8 +612,8 @@ public isolated client class Client { # # + threadId - The ID of the [thread](/docs/api-reference/threads) to which this run belongs # + runId - The ID of the run that requires the tool output submission - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post threads/[string threadId]/runs/[string runId]/submit_tool_outputs(SubmitToolOutputsRunRequest payload, map headers = {}) returns RunObject|error { string resourcePath = string `/threads/${getEncodedUri(threadId)}/runs/${getEncodedUri(runId)}/submit_tool_outputs`; http:Request request = new; @@ -626,8 +626,8 @@ public isolated client class Client { # # + threadId - The ID of the thread to which this run belongs # + runId - The ID of the run to cancel - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post threads/[string threadId]/runs/[string runId]/cancel(map headers = {}) returns RunObject|error { string resourcePath = string `/threads/${getEncodedUri(threadId)}/runs/${getEncodedUri(runId)}/cancel`; http:Request request = new; @@ -638,9 +638,9 @@ public isolated client class Client { # # + threadId - The ID of the thread the run and run steps belong to # + runId - The ID of the run the run steps belong to - # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - OK resource isolated function get threads/[string threadId]/runs/[string runId]/steps(map headers = {}, *ListRunStepsQueries queries) returns ListRunStepsResponse|error { string resourcePath = string `/threads/${getEncodedUri(threadId)}/runs/${getEncodedUri(runId)}/steps`; resourcePath = resourcePath + check getPathForQueryParam(queries); @@ -652,8 +652,8 @@ public isolated client class Client { # + threadId - The ID of the thread to which the run and run step belongs # + runId - The ID of the run to which the run step belongs # + stepId - The ID of the run step to retrieve - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function get threads/[string threadId]/runs/[string runId]/steps/[string stepId](map headers = {}) returns RunStepObject|error { string resourcePath = string `/threads/${getEncodedUri(threadId)}/runs/${getEncodedUri(runId)}/steps/${getEncodedUri(stepId)}`; return self.clientEp->get(resourcePath, headers); @@ -661,9 +661,9 @@ public isolated client class Client { # Returns a list of vector stores. # - # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - OK resource isolated function get vector_stores(map headers = {}, *ListVectorStoresQueries queries) returns ListVectorStoresResponse|error { string resourcePath = string `/vector_stores`; resourcePath = resourcePath + check getPathForQueryParam(queries); @@ -672,8 +672,8 @@ public isolated client class Client { # Create a vector store. # - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post vector_stores(CreateVectorStoreRequest payload, map headers = {}) returns VectorStoreObject|error { string resourcePath = string `/vector_stores`; http:Request request = new; @@ -685,8 +685,8 @@ public isolated client class Client { # Retrieves a vector store. # # + vectorStoreId - The ID of the vector store to retrieve - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function get vector_stores/[string vectorStoreId](map headers = {}) returns VectorStoreObject|error { string resourcePath = string `/vector_stores/${getEncodedUri(vectorStoreId)}`; return self.clientEp->get(resourcePath, headers); @@ -695,8 +695,8 @@ public isolated client class Client { # Modifies a vector store. # # + vectorStoreId - The ID of the vector store to modify - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post vector_stores/[string vectorStoreId](UpdateVectorStoreRequest payload, map headers = {}) returns VectorStoreObject|error { string resourcePath = string `/vector_stores/${getEncodedUri(vectorStoreId)}`; http:Request request = new; @@ -708,8 +708,8 @@ public isolated client class Client { # Delete a vector store. # # + vectorStoreId - The ID of the vector store to delete - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function delete vector_stores/[string vectorStoreId](map headers = {}) returns DeleteVectorStoreResponse|error { string resourcePath = string `/vector_stores/${getEncodedUri(vectorStoreId)}`; return self.clientEp->delete(resourcePath, headers = headers); @@ -718,9 +718,9 @@ public isolated client class Client { # Returns a list of vector store files. # # + vectorStoreId - The ID of the vector store that the files belong to - # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - OK resource isolated function get vector_stores/[string vectorStoreId]/files(map headers = {}, *ListVectorStoreFilesQueries queries) returns ListVectorStoreFilesResponse|error { string resourcePath = string `/vector_stores/${getEncodedUri(vectorStoreId)}/files`; resourcePath = resourcePath + check getPathForQueryParam(queries); @@ -730,8 +730,8 @@ public isolated client class Client { # Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object). # # + vectorStoreId - The ID of the vector store for which to create a File - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post vector_stores/[string vectorStoreId]/files(CreateVectorStoreFileRequest payload, map headers = {}) returns VectorStoreFileObject|error { string resourcePath = string `/vector_stores/${getEncodedUri(vectorStoreId)}/files`; http:Request request = new; @@ -744,8 +744,8 @@ public isolated client class Client { # # + vectorStoreId - The ID of the vector store that the file belongs to # + fileId - The ID of the file being retrieved - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function get vector_stores/[string vectorStoreId]/files/[string fileId](map headers = {}) returns VectorStoreFileObject|error { string resourcePath = string `/vector_stores/${getEncodedUri(vectorStoreId)}/files/${getEncodedUri(fileId)}`; return self.clientEp->get(resourcePath, headers); @@ -755,8 +755,8 @@ public isolated client class Client { # # + vectorStoreId - The ID of the vector store that the file belongs to # + fileId - The ID of the file to delete - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function delete vector_stores/[string vectorStoreId]/files/[string fileId](map headers = {}) returns DeleteVectorStoreFileResponse|error { string resourcePath = string `/vector_stores/${getEncodedUri(vectorStoreId)}/files/${getEncodedUri(fileId)}`; return self.clientEp->delete(resourcePath, headers = headers); @@ -765,8 +765,8 @@ public isolated client class Client { # Create a vector store file batch. # # + vectorStoreId - The ID of the vector store for which to create a File Batch - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post vector_stores/[string vectorStoreId]/file_batches(CreateVectorStoreFileBatchRequest payload, map headers = {}) returns VectorStoreFileBatchObject|error { string resourcePath = string `/vector_stores/${getEncodedUri(vectorStoreId)}/file_batches`; http:Request request = new; @@ -779,8 +779,8 @@ public isolated client class Client { # # + vectorStoreId - The ID of the vector store that the file batch belongs to # + batchId - The ID of the file batch being retrieved - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function get vector_stores/[string vectorStoreId]/file_batches/[string batchId](map headers = {}) returns VectorStoreFileBatchObject|error { string resourcePath = string `/vector_stores/${getEncodedUri(vectorStoreId)}/file_batches/${getEncodedUri(batchId)}`; return self.clientEp->get(resourcePath, headers); @@ -790,8 +790,8 @@ public isolated client class Client { # # + vectorStoreId - The ID of the vector store that the file batch belongs to # + batchId - The ID of the file batch to cancel - # + headers - Headers to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + return - OK resource isolated function post vector_stores/[string vectorStoreId]/file_batches/[string batchId]/cancel(map headers = {}) returns VectorStoreFileBatchObject|error { string resourcePath = string `/vector_stores/${getEncodedUri(vectorStoreId)}/file_batches/${getEncodedUri(batchId)}/cancel`; http:Request request = new; @@ -802,9 +802,9 @@ public isolated client class Client { # # + vectorStoreId - The ID of the vector store that the files belong to # + batchId - The ID of the file batch that the files belong to - # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request - # + return - OK + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - OK resource isolated function get vector_stores/[string vectorStoreId]/file_batches/[string batchId]/files(map headers = {}, *ListFilesInVectorStoreBatchQueries queries) returns ListVectorStoreFilesResponse|error { string resourcePath = string `/vector_stores/${getEncodedUri(vectorStoreId)}/file_batches/${getEncodedUri(batchId)}/files`; resourcePath = resourcePath + check getPathForQueryParam(queries); @@ -813,9 +813,9 @@ public isolated client class Client { # List your organization's batches. # - # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request - # + return - Batch listed successfully + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - Batch listed successfully resource isolated function get batches(map headers = {}, *ListBatchesQueries queries) returns ListBatchesResponse|error { string resourcePath = string `/batches`; resourcePath = resourcePath + check getPathForQueryParam(queries); @@ -824,8 +824,8 @@ public isolated client class Client { # Creates and executes a batch from an uploaded file of requests # - # + headers - Headers to be sent with the request - # + return - Batch created successfully + # + headers - Headers to be sent with the request + # + return - Batch created successfully resource isolated function post batches(BatchesBody payload, map headers = {}) returns Batch|error { string resourcePath = string `/batches`; http:Request request = new; @@ -837,8 +837,8 @@ public isolated client class Client { # Retrieves a batch. # # + batchId - The ID of the batch to retrieve - # + headers - Headers to be sent with the request - # + return - Batch retrieved successfully + # + headers - Headers to be sent with the request + # + return - Batch retrieved successfully resource isolated function get batches/[string batchId](map headers = {}) returns Batch|error { string resourcePath = string `/batches/${getEncodedUri(batchId)}`; return self.clientEp->get(resourcePath, headers); @@ -847,8 +847,8 @@ public isolated client class Client { # Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes, before changing to `cancelled`, where it will have partial results (if any) available in the output file. # # + batchId - The ID of the batch to cancel - # + headers - Headers to be sent with the request - # + return - Batch is cancelling. Returns the cancelling batch's details + # + headers - Headers to be sent with the request + # + return - Batch is cancelling. Returns the cancelling batch's details resource isolated function post batches/[string batchId]/cancel(map headers = {}) returns Batch|error { string resourcePath = string `/batches/${getEncodedUri(batchId)}/cancel`; http:Request request = new; diff --git a/ballerina/types.bal b/ballerina/types.bal index 584639c..dabe8c4 100644 --- a/ballerina/types.bal +++ b/ballerina/types.bal @@ -44,6 +44,7 @@ public type FineTuningJobCheckpoint record { string fineTuningJobId; # The checkpoint identifier, which can be referenced in the API endpoints string id; + # Metrics at the step number during the fine-tuning job FineTuningJobCheckpointMetrics metrics; # The name of the fine-tuned checkpoint model that is created @jsondata:Name {value: "fine_tuned_model_checkpoint"} @@ -74,6 +75,7 @@ public type ListRunsResponse record { public type AssistantsApiResponseFormatOption AssistantsApiResponseFormatOptionOneOf1|AssistantsApiResponseFormat; public type RunStepDetailsToolCallsFunctionObject record { + # The definition of the function that was called RunStepDetailsToolCallsFunctionObjectFunction 'function; # The ID of the tool call object string id; @@ -556,6 +558,7 @@ public type CompletionUsage record { # Tool call objects public type RunToolCallObject record { + # The function definition RunToolCallObjectFunction 'function; # The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](/docs/api-reference/runs/submitToolOutputs) endpoint string id; @@ -693,6 +696,7 @@ public type CreateCompletionRequest record { public type CreateCompletionResponse record { # The Unix timestamp (in seconds) of when the completion was created int created; + # Usage statistics for the completion request CompletionUsage usage?; # The model used for completion string model; @@ -994,6 +998,7 @@ public type ListBatchesResponse record { public type CreateEmbeddingResponse record { # The list of embeddings generated by the model Embedding[] data; + # The usage information for the request CreateEmbeddingResponseUsage usage; # The name of the model used to generate the embedding string model; @@ -1046,6 +1051,7 @@ public type RunObject record { string assistantId; @jsondata:Name {value: "required_action"} RunObjectRequiredAction? requiredAction; + # Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.) RunCompletionUsage? usage; # The Unix timestamp (in seconds) for when the run was created @jsondata:Name {value: "created_at"} @@ -1545,6 +1551,7 @@ public type CreateFineTuningJobRequest record { # See the [fine-tuning guide](/docs/guides/fine-tuning) for more details @jsondata:Name {value: "validation_file"} string? validationFile?; + # The hyperparameters used for the fine-tuning job CreateFineTuningJobRequestHyperparameters hyperparameters?; # The name of the model to fine-tune. You can select one of the # [supported models](/docs/guides/fine-tuning/what-models-can-be-fine-tuned) @@ -1565,6 +1572,9 @@ public type MessageContentImageUrlObjectImageUrl record { }; public type CreateFineTuningJobRequestIntegrations record { + # The settings for your integration with Weights and Biases. This payload specifies the project that + # metrics will be sent to. Optionally, you can set an explicit display name for your run, add tags + # to your run, and set a default entity (team, username, etc) to be associated with your run CreateFineTuningJobRequestWandb wandb; # The type of integration to enable. Currently, only "wandb" (Weights and Biases) is supported "wandb" 'type; @@ -1686,6 +1696,9 @@ public type ChatCompletionFunctions record { string name; # A description of what the function does, used by the model to choose when and how to call the function string description?; + # The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. + # + # Omitting `parameters` defines a function with an empty parameter list FunctionParameters parameters?; }; @@ -1829,6 +1842,7 @@ public type Upload record { # The Unix timestamp (in seconds) for when the Upload was created @jsondata:Name {value: "expires_at"} int expiresAt; + # The `File` object represents a document that has been uploaded to OpenAI OpenAIFile file?; # The intended purpose of the file. [Please refer here](/docs/api-reference/files/object#files/object-purpose) for acceptable values string purpose; @@ -1954,6 +1968,7 @@ public type DeleteModelResponse record { }; public type ChatCompletionMessageToolCall record { + # The function that the model called ChatCompletionMessageToolCallFunction 'function; # The ID of the tool call string id; @@ -2052,7 +2067,9 @@ public type CreateChatCompletionResponseChoices record { "stop"|"length"|"tool_calls"|"content_filter"|"function_call" finishReason; # The index of the choice in the list of choices int index; + # A chat completion message generated by the model ChatCompletionResponseMessage message; + # Log probability information for the choice CreateChatCompletionResponseLogprobs? logprobs; }; @@ -2197,6 +2214,9 @@ public type CreateModerationResponse record { }; public type FineTuningIntegration record { + # The settings for your integration with Weights and Biases. This payload specifies the project that + # metrics will be sent to. Optionally, you can set an explicit display name for your run, add tags + # to your run, and set a default entity (team, username, etc) to be associated with your run FineTuningIntegrationWandb wandb; # The type of the integration being enabled for the fine-tuning job "wandb" 'type; @@ -2275,6 +2295,7 @@ public type FineTuningJob record { # The Unix timestamp (in seconds) for when the fine-tuning job was created @jsondata:Name {value: "created_at"} int createdAt; + # For fine-tuning jobs that have `failed`, this will contain more information on the cause of the failure FineTuningJobError? 'error; # The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running @jsondata:Name {value: "estimated_finish"} @@ -2282,6 +2303,7 @@ public type FineTuningJob record { # The organization that owns the fine-tuning job @jsondata:Name {value: "organization_id"} string organizationId; + # The hyperparameters used for the fine-tuning job. See the [fine-tuning guide](/docs/guides/fine-tuning) for more details FineTuningJobHyperparameters hyperparameters; # The base model that is being fine-tuned string model; @@ -2394,6 +2416,7 @@ public type RunStepObject record { # The ID of the [run](/docs/api-reference/runs) that this run step is a part of @jsondata:Name {value: "run_id"} string runId; + # Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress` RunStepCompletionUsage? usage; # The Unix timestamp (in seconds) for when the run step was created @jsondata:Name {value: "created_at"} @@ -2437,6 +2460,7 @@ public type CreateModerationResponseResults record { CreateModerationResponseCategoryScores categoryScores; # Whether any of the below categories are flagged boolean flagged; + # A list of the categories, and whether they are flagged or not CreateModerationResponseCategories categories; }; @@ -2459,6 +2483,9 @@ public type FunctionObject record { string name; # A description of what the function does, used by the model to choose when and how to call the function string description?; + # The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. + # + # Omitting `parameters` defines a function with an empty parameter list FunctionParameters parameters?; }; @@ -2557,6 +2584,7 @@ public type UploadPart record { public type CreateChatCompletionResponse record { # The Unix timestamp (in seconds) of when the chat completion was created int created; + # Usage statistics for the completion request CompletionUsage usage?; # The model used for the chat completion string model;