openapi_openai 1.0.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/README.md +274 -51
- data/docs/AssistantFileObject.md +24 -0
- data/docs/AssistantObject.md +36 -0
- data/docs/AssistantObjectToolsInner.md +51 -0
- data/docs/AssistantStreamEvent.md +57 -0
- data/docs/AssistantToolsCode.md +18 -0
- data/docs/AssistantToolsFunction.md +20 -0
- data/docs/AssistantToolsRetrieval.md +18 -0
- data/docs/AssistantsApi.md +2017 -0
- data/docs/AssistantsApiNamedToolChoice.md +20 -0
- data/docs/AssistantsApiResponseFormat.md +18 -0
- data/docs/AssistantsApiResponseFormatOption.md +49 -0
- data/docs/AssistantsApiToolChoiceOption.md +49 -0
- data/docs/AudioApi.md +235 -0
- data/docs/ChatApi.md +75 -0
- data/docs/{CreateChatCompletionRequestFunctionCallOneOf.md → ChatCompletionFunctionCallOption.md} +2 -2
- data/docs/ChatCompletionFunctions.md +3 -3
- data/docs/ChatCompletionMessageToolCall.md +22 -0
- data/docs/ChatCompletionMessageToolCallChunk.md +24 -0
- data/docs/{ChatCompletionRequestMessageFunctionCall.md → ChatCompletionMessageToolCallChunkFunction.md} +2 -2
- data/docs/ChatCompletionMessageToolCallFunction.md +20 -0
- data/docs/ChatCompletionNamedToolChoice.md +20 -0
- data/docs/ChatCompletionNamedToolChoiceFunction.md +18 -0
- data/docs/ChatCompletionRequestAssistantMessage.md +26 -0
- data/docs/ChatCompletionRequestAssistantMessageFunctionCall.md +20 -0
- data/docs/ChatCompletionRequestFunctionMessage.md +22 -0
- data/docs/ChatCompletionRequestMessage.md +45 -14
- data/docs/ChatCompletionRequestMessageContentPart.md +49 -0
- data/docs/ChatCompletionRequestMessageContentPartImage.md +20 -0
- data/docs/ChatCompletionRequestMessageContentPartImageImageUrl.md +20 -0
- data/docs/ChatCompletionRequestMessageContentPartText.md +20 -0
- data/docs/ChatCompletionRequestSystemMessage.md +22 -0
- data/docs/ChatCompletionRequestToolMessage.md +22 -0
- data/docs/ChatCompletionRequestUserMessage.md +22 -0
- data/docs/ChatCompletionRequestUserMessageContent.md +49 -0
- data/docs/ChatCompletionResponseMessage.md +5 -3
- data/docs/ChatCompletionRole.md +15 -0
- data/docs/ChatCompletionStreamResponseDelta.md +6 -4
- data/docs/ChatCompletionStreamResponseDeltaFunctionCall.md +20 -0
- data/docs/ChatCompletionTokenLogprob.md +24 -0
- data/docs/ChatCompletionTokenLogprobTopLogprobsInner.md +22 -0
- data/docs/ChatCompletionTool.md +20 -0
- data/docs/ChatCompletionToolChoiceOption.md +49 -0
- data/docs/CompletionUsage.md +22 -0
- data/docs/CompletionsApi.md +75 -0
- data/docs/CreateAssistantFileRequest.md +18 -0
- data/docs/CreateAssistantRequest.md +30 -0
- data/docs/CreateAssistantRequestModel.md +15 -0
- data/docs/CreateChatCompletionFunctionResponse.md +30 -0
- data/docs/CreateChatCompletionFunctionResponseChoicesInner.md +22 -0
- data/docs/CreateChatCompletionRequest.md +33 -21
- data/docs/CreateChatCompletionRequestFunctionCall.md +3 -3
- data/docs/CreateChatCompletionRequestModel.md +5 -37
- data/docs/CreateChatCompletionRequestResponseFormat.md +18 -0
- data/docs/CreateChatCompletionResponse.md +10 -8
- data/docs/CreateChatCompletionResponseChoicesInner.md +6 -4
- data/docs/CreateChatCompletionResponseChoicesInnerLogprobs.md +18 -0
- data/docs/CreateChatCompletionStreamResponse.md +9 -7
- data/docs/CreateChatCompletionStreamResponseChoicesInner.md +7 -5
- data/docs/CreateCompletionRequest.md +23 -21
- data/docs/CreateCompletionRequestModel.md +5 -37
- data/docs/CreateCompletionResponse.md +10 -8
- data/docs/CreateCompletionResponseChoicesInner.md +4 -4
- data/docs/CreateCompletionResponseChoicesInnerLogprobs.md +6 -6
- data/docs/CreateEmbeddingRequest.md +6 -2
- data/docs/CreateEmbeddingRequestModel.md +5 -37
- data/docs/CreateEmbeddingResponse.md +5 -5
- data/docs/CreateEmbeddingResponseUsage.md +2 -2
- data/docs/CreateFineTuningJobRequest.md +30 -0
- data/docs/CreateFineTuningJobRequestHyperparameters.md +22 -0
- data/docs/CreateFineTuningJobRequestHyperparametersBatchSize.md +49 -0
- data/docs/CreateFineTuningJobRequestHyperparametersLearningRateMultiplier.md +49 -0
- data/docs/CreateFineTuningJobRequestHyperparametersNEpochs.md +49 -0
- data/docs/CreateFineTuningJobRequestIntegrationsInner.md +20 -0
- data/docs/{CreateFineTuneRequestModel.md → CreateFineTuningJobRequestIntegrationsInnerType.md} +4 -4
- data/docs/CreateFineTuningJobRequestIntegrationsInnerWandb.md +24 -0
- data/docs/CreateFineTuningJobRequestModel.md +15 -0
- data/docs/CreateImageEditRequestModel.md +15 -0
- data/docs/CreateImageRequest.md +11 -5
- data/docs/CreateImageRequestModel.md +15 -0
- data/docs/CreateMessageRequest.md +24 -0
- data/docs/CreateModerationRequestModel.md +5 -37
- data/docs/CreateModerationResponse.md +3 -3
- data/docs/CreateModerationResponseResultsInner.md +1 -1
- data/docs/CreateModerationResponseResultsInnerCategories.md +15 -7
- data/docs/CreateModerationResponseResultsInnerCategoryScores.md +15 -7
- data/docs/CreateRunRequest.md +44 -0
- data/docs/CreateRunRequestModel.md +15 -0
- data/docs/CreateSpeechRequest.md +26 -0
- data/docs/CreateSpeechRequestModel.md +15 -0
- data/docs/CreateThreadAndRunRequest.md +42 -0
- data/docs/CreateThreadAndRunRequestToolsInner.md +51 -0
- data/docs/CreateThreadRequest.md +20 -0
- data/docs/CreateTranscription200Response.md +49 -0
- data/docs/CreateTranscriptionRequestModel.md +5 -37
- data/docs/CreateTranscriptionResponseJson.md +18 -0
- data/docs/CreateTranscriptionResponseVerboseJson.md +26 -0
- data/docs/CreateTranslation200Response.md +49 -0
- data/docs/{CreateTranscriptionResponse.md → CreateTranslationResponseJson.md} +2 -2
- data/docs/CreateTranslationResponseVerboseJson.md +24 -0
- data/docs/DeleteAssistantFileResponse.md +22 -0
- data/docs/DeleteAssistantResponse.md +22 -0
- data/docs/DeleteMessageResponse.md +22 -0
- data/docs/DeleteModelResponse.md +3 -3
- data/docs/DeleteThreadResponse.md +22 -0
- data/docs/DoneEvent.md +20 -0
- data/docs/Embedding.md +22 -0
- data/docs/EmbeddingsApi.md +75 -0
- data/docs/Error.md +4 -4
- data/docs/ErrorEvent.md +20 -0
- data/docs/FilesApi.md +351 -0
- data/docs/FineTuningApi.md +431 -0
- data/docs/FineTuningIntegration.md +20 -0
- data/docs/FineTuningJob.md +48 -0
- data/docs/FineTuningJobCheckpoint.md +30 -0
- data/docs/FineTuningJobCheckpointMetrics.md +30 -0
- data/docs/FineTuningJobError.md +22 -0
- data/docs/{FineTuneEvent.md → FineTuningJobEvent.md} +7 -5
- data/docs/FineTuningJobHyperparameters.md +18 -0
- data/docs/FineTuningJobHyperparametersNEpochs.md +49 -0
- data/docs/FineTuningJobIntegrationsInner.md +47 -0
- data/docs/FunctionObject.md +22 -0
- data/docs/Image.md +22 -0
- data/docs/ImagesApi.md +239 -0
- data/docs/ImagesResponse.md +1 -1
- data/docs/ListAssistantFilesResponse.md +26 -0
- data/docs/ListAssistantsResponse.md +26 -0
- data/docs/ListFilesResponse.md +3 -3
- data/docs/ListFineTuningJobCheckpointsResponse.md +26 -0
- data/docs/ListFineTuningJobEventsResponse.md +20 -0
- data/docs/ListMessageFilesResponse.md +26 -0
- data/docs/ListMessagesResponse.md +26 -0
- data/docs/ListPaginatedFineTuningJobsResponse.md +22 -0
- data/docs/ListRunStepsResponse.md +26 -0
- data/docs/ListRunsResponse.md +26 -0
- data/docs/ListThreadsResponse.md +26 -0
- data/docs/MessageContentImageFileObject.md +20 -0
- data/docs/MessageContentImageFileObjectImageFile.md +18 -0
- data/docs/MessageContentTextAnnotationsFileCitationObject.md +26 -0
- data/docs/MessageContentTextAnnotationsFileCitationObjectFileCitation.md +20 -0
- data/docs/MessageContentTextAnnotationsFilePathObject.md +26 -0
- data/docs/MessageContentTextAnnotationsFilePathObjectFilePath.md +18 -0
- data/docs/MessageContentTextObject.md +20 -0
- data/docs/MessageContentTextObjectText.md +20 -0
- data/docs/MessageContentTextObjectTextAnnotationsInner.md +49 -0
- data/docs/MessageDeltaContentImageFileObject.md +22 -0
- data/docs/MessageDeltaContentImageFileObjectImageFile.md +18 -0
- data/docs/MessageDeltaContentTextAnnotationsFileCitationObject.md +28 -0
- data/docs/MessageDeltaContentTextAnnotationsFileCitationObjectFileCitation.md +20 -0
- data/docs/MessageDeltaContentTextAnnotationsFilePathObject.md +28 -0
- data/docs/MessageDeltaContentTextAnnotationsFilePathObjectFilePath.md +18 -0
- data/docs/MessageDeltaContentTextObject.md +22 -0
- data/docs/MessageDeltaContentTextObjectText.md +20 -0
- data/docs/MessageDeltaContentTextObjectTextAnnotationsInner.md +49 -0
- data/docs/MessageDeltaObject.md +22 -0
- data/docs/MessageDeltaObjectDelta.md +22 -0
- data/docs/MessageDeltaObjectDeltaContentInner.md +49 -0
- data/docs/MessageFileObject.md +24 -0
- data/docs/MessageObject.md +44 -0
- data/docs/MessageObjectContentInner.md +49 -0
- data/docs/MessageObjectIncompleteDetails.md +18 -0
- data/docs/MessageStreamEvent.md +55 -0
- data/docs/MessageStreamEventOneOf.md +20 -0
- data/docs/MessageStreamEventOneOf1.md +20 -0
- data/docs/MessageStreamEventOneOf2.md +20 -0
- data/docs/MessageStreamEventOneOf3.md +20 -0
- data/docs/MessageStreamEventOneOf4.md +20 -0
- data/docs/Model.md +5 -5
- data/docs/ModelsApi.md +208 -0
- data/docs/ModerationsApi.md +75 -0
- data/docs/ModifyAssistantRequest.md +30 -0
- data/docs/ModifyMessageRequest.md +18 -0
- data/docs/ModifyRunRequest.md +18 -0
- data/docs/ModifyThreadRequest.md +18 -0
- data/docs/OpenAIFile.md +9 -9
- data/docs/RunCompletionUsage.md +22 -0
- data/docs/RunObject.md +68 -0
- data/docs/RunObjectIncompleteDetails.md +18 -0
- data/docs/RunObjectLastError.md +20 -0
- data/docs/RunObjectRequiredAction.md +20 -0
- data/docs/RunObjectRequiredActionSubmitToolOutputs.md +18 -0
- data/docs/RunStepCompletionUsage.md +22 -0
- data/docs/RunStepDeltaObject.md +22 -0
- data/docs/RunStepDeltaObjectDelta.md +18 -0
- data/docs/RunStepDeltaObjectDeltaStepDetails.md +49 -0
- data/docs/RunStepDeltaStepDetailsMessageCreationObject.md +20 -0
- data/docs/RunStepDeltaStepDetailsMessageCreationObjectMessageCreation.md +18 -0
- data/docs/RunStepDeltaStepDetailsToolCallsCodeObject.md +24 -0
- data/docs/RunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreter.md +20 -0
- data/docs/RunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreterOutputsInner.md +49 -0
- data/docs/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject.md +22 -0
- data/docs/RunStepDeltaStepDetailsToolCallsCodeOutputImageObjectImage.md +18 -0
- data/docs/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject.md +22 -0
- data/docs/RunStepDeltaStepDetailsToolCallsFunctionObject.md +24 -0
- data/docs/RunStepDeltaStepDetailsToolCallsFunctionObjectFunction.md +22 -0
- data/docs/RunStepDeltaStepDetailsToolCallsObject.md +20 -0
- data/docs/RunStepDeltaStepDetailsToolCallsObjectToolCallsInner.md +51 -0
- data/docs/RunStepDeltaStepDetailsToolCallsRetrievalObject.md +24 -0
- data/docs/RunStepDetailsMessageCreationObject.md +20 -0
- data/docs/RunStepDetailsMessageCreationObjectMessageCreation.md +18 -0
- data/docs/RunStepDetailsToolCallsCodeObject.md +22 -0
- data/docs/RunStepDetailsToolCallsCodeObjectCodeInterpreter.md +20 -0
- data/docs/RunStepDetailsToolCallsCodeObjectCodeInterpreterOutputsInner.md +49 -0
- data/docs/RunStepDetailsToolCallsCodeOutputImageObject.md +20 -0
- data/docs/RunStepDetailsToolCallsCodeOutputImageObjectImage.md +18 -0
- data/docs/RunStepDetailsToolCallsCodeOutputLogsObject.md +20 -0
- data/docs/RunStepDetailsToolCallsFunctionObject.md +22 -0
- data/docs/RunStepDetailsToolCallsFunctionObjectFunction.md +22 -0
- data/docs/RunStepDetailsToolCallsObject.md +20 -0
- data/docs/RunStepDetailsToolCallsObjectToolCallsInner.md +51 -0
- data/docs/RunStepDetailsToolCallsRetrievalObject.md +22 -0
- data/docs/RunStepObject.md +48 -0
- data/docs/RunStepObjectLastError.md +20 -0
- data/docs/RunStepObjectStepDetails.md +49 -0
- data/docs/RunStepStreamEvent.md +59 -0
- data/docs/RunStepStreamEventOneOf.md +20 -0
- data/docs/RunStepStreamEventOneOf1.md +20 -0
- data/docs/RunStepStreamEventOneOf2.md +20 -0
- data/docs/RunStepStreamEventOneOf3.md +20 -0
- data/docs/RunStepStreamEventOneOf4.md +20 -0
- data/docs/RunStepStreamEventOneOf5.md +20 -0
- data/docs/RunStepStreamEventOneOf6.md +20 -0
- data/docs/RunStreamEvent.md +63 -0
- data/docs/RunStreamEventOneOf.md +20 -0
- data/docs/RunStreamEventOneOf1.md +20 -0
- data/docs/RunStreamEventOneOf2.md +20 -0
- data/docs/RunStreamEventOneOf3.md +20 -0
- data/docs/RunStreamEventOneOf4.md +20 -0
- data/docs/RunStreamEventOneOf5.md +20 -0
- data/docs/RunStreamEventOneOf6.md +20 -0
- data/docs/RunStreamEventOneOf7.md +20 -0
- data/docs/RunStreamEventOneOf8.md +20 -0
- data/docs/RunToolCallObject.md +22 -0
- data/docs/RunToolCallObjectFunction.md +20 -0
- data/docs/SubmitToolOutputsRunRequest.md +20 -0
- data/docs/SubmitToolOutputsRunRequestToolOutputsInner.md +20 -0
- data/docs/ThreadObject.md +24 -0
- data/docs/{CreateEditRequestModel.md → ThreadStreamEvent.md} +7 -7
- data/docs/ThreadStreamEventOneOf.md +20 -0
- data/docs/TranscriptionSegment.md +36 -0
- data/docs/TranscriptionWord.md +22 -0
- data/docs/TruncationObject.md +20 -0
- data/lib/openapi_openai/api/assistants_api.rb +2006 -0
- data/lib/openapi_openai/api/audio_api.rb +268 -0
- data/lib/openapi_openai/api/chat_api.rb +88 -0
- data/lib/openapi_openai/api/completions_api.rb +88 -0
- data/lib/openapi_openai/api/embeddings_api.rb +88 -0
- data/lib/openapi_openai/api/files_api.rb +342 -0
- data/lib/openapi_openai/api/fine_tuning_api.rb +405 -0
- data/lib/openapi_openai/api/images_api.rb +294 -0
- data/lib/openapi_openai/api/models_api.rb +199 -0
- data/lib/openapi_openai/api/moderations_api.rb +88 -0
- data/lib/openapi_openai/api_client.rb +2 -1
- data/lib/openapi_openai/api_error.rb +1 -1
- data/lib/openapi_openai/configuration.rb +8 -1
- data/lib/openapi_openai/models/assistant_file_object.rb +308 -0
- data/lib/openapi_openai/models/assistant_object.rb +481 -0
- data/lib/openapi_openai/models/assistant_object_tools_inner.rb +106 -0
- data/lib/openapi_openai/models/assistant_stream_event.rb +110 -0
- data/lib/openapi_openai/models/assistant_tools_code.rb +256 -0
- data/lib/openapi_openai/models/assistant_tools_function.rb +272 -0
- data/lib/openapi_openai/models/assistant_tools_retrieval.rb +256 -0
- data/lib/openapi_openai/models/assistants_api_named_tool_choice.rb +266 -0
- data/lib/openapi_openai/models/assistants_api_response_format.rb +252 -0
- data/lib/openapi_openai/models/assistants_api_response_format_option.rb +106 -0
- data/lib/openapi_openai/models/assistants_api_tool_choice_option.rb +106 -0
- data/lib/openapi_openai/models/chat_completion_function_call_option.rb +223 -0
- data/lib/openapi_openai/models/chat_completion_functions.rb +13 -13
- data/lib/openapi_openai/models/chat_completion_message_tool_call.rb +289 -0
- data/lib/openapi_openai/models/chat_completion_message_tool_call_chunk.rb +284 -0
- data/lib/openapi_openai/models/{chat_completion_request_message_function_call.rb → chat_completion_message_tool_call_chunk_function.rb} +4 -5
- data/lib/openapi_openai/models/chat_completion_message_tool_call_function.rb +240 -0
- data/lib/openapi_openai/models/chat_completion_named_tool_choice.rb +273 -0
- data/lib/openapi_openai/models/{create_chat_completion_request_function_call_one_of.rb → chat_completion_named_tool_choice_function.rb} +4 -4
- data/lib/openapi_openai/models/chat_completion_request_assistant_message.rb +298 -0
- data/lib/openapi_openai/models/chat_completion_request_assistant_message_function_call.rb +240 -0
- data/lib/openapi_openai/models/chat_completion_request_function_message.rb +286 -0
- data/lib/openapi_openai/models/chat_completion_request_message.rb +78 -255
- data/lib/openapi_openai/models/chat_completion_request_message_content_part.rb +105 -0
- data/lib/openapi_openai/models/chat_completion_request_message_content_part_image.rb +272 -0
- data/lib/openapi_openai/models/chat_completion_request_message_content_part_image_image_url.rb +268 -0
- data/lib/openapi_openai/models/chat_completion_request_message_content_part_text.rb +273 -0
- data/lib/openapi_openai/models/chat_completion_request_system_message.rb +283 -0
- data/lib/openapi_openai/models/chat_completion_request_tool_message.rb +290 -0
- data/lib/openapi_openai/models/chat_completion_request_user_message.rb +282 -0
- data/lib/openapi_openai/models/{create_fine_tune_request_model.rb → chat_completion_request_user_message_content.rb} +4 -3
- data/lib/openapi_openai/models/chat_completion_response_message.rb +30 -15
- data/lib/openapi_openai/models/chat_completion_role.rb +43 -0
- data/lib/openapi_openai/models/chat_completion_stream_response_delta.rb +29 -17
- data/lib/openapi_openai/models/chat_completion_stream_response_delta_function_call.rb +226 -0
- data/lib/openapi_openai/models/chat_completion_token_logprob.rb +273 -0
- data/lib/openapi_openai/models/chat_completion_token_logprob_top_logprobs_inner.rb +254 -0
- data/lib/openapi_openai/models/chat_completion_tool.rb +272 -0
- data/lib/openapi_openai/models/chat_completion_tool_choice_option.rb +106 -0
- data/lib/openapi_openai/models/{create_completion_response_usage.rb → completion_usage.rb} +25 -21
- data/lib/openapi_openai/models/create_assistant_file_request.rb +222 -0
- data/lib/openapi_openai/models/create_assistant_request.rb +372 -0
- data/lib/openapi_openai/models/create_assistant_request_model.rb +104 -0
- data/lib/openapi_openai/models/create_chat_completion_function_response.rb +346 -0
- data/lib/openapi_openai/models/create_chat_completion_function_response_choices_inner.rb +289 -0
- data/lib/openapi_openai/models/create_chat_completion_request.rb +277 -152
- data/lib/openapi_openai/models/create_chat_completion_request_function_call.rb +3 -3
- data/lib/openapi_openai/models/create_chat_completion_request_model.rb +8 -9
- data/lib/openapi_openai/models/create_chat_completion_request_response_format.rb +252 -0
- data/lib/openapi_openai/models/create_chat_completion_request_stop.rb +1 -1
- data/lib/openapi_openai/models/create_chat_completion_response.rb +75 -25
- data/lib/openapi_openai/models/create_chat_completion_response_choices_inner.rb +45 -10
- data/lib/openapi_openai/models/create_chat_completion_response_choices_inner_logprobs.rb +221 -0
- data/lib/openapi_openai/models/create_chat_completion_stream_response.rb +74 -24
- data/lib/openapi_openai/models/create_chat_completion_stream_response_choices_inner.rb +45 -16
- data/lib/openapi_openai/models/create_completion_request.rb +219 -182
- data/lib/openapi_openai/models/create_completion_request_model.rb +8 -9
- data/lib/openapi_openai/models/create_completion_request_prompt.rb +1 -1
- data/lib/openapi_openai/models/create_completion_request_stop.rb +1 -1
- data/lib/openapi_openai/models/create_completion_response.rb +75 -25
- data/lib/openapi_openai/models/create_completion_response_choices_inner.rb +25 -24
- data/lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb +23 -23
- data/lib/openapi_openai/models/create_embedding_request.rb +87 -12
- data/lib/openapi_openai/models/create_embedding_request_input.rb +2 -2
- data/lib/openapi_openai/models/create_embedding_request_model.rb +8 -9
- data/lib/openapi_openai/models/create_embedding_response.rb +61 -24
- data/lib/openapi_openai/models/create_embedding_response_usage.rb +4 -1
- data/lib/openapi_openai/models/{create_fine_tune_request.rb → create_fine_tuning_job_request.rb} +78 -111
- data/lib/openapi_openai/models/create_fine_tuning_job_request_hyperparameters.rb +233 -0
- data/lib/openapi_openai/models/create_fine_tuning_job_request_hyperparameters_batch_size.rb +106 -0
- data/lib/openapi_openai/models/create_fine_tuning_job_request_hyperparameters_learning_rate_multiplier.rb +106 -0
- data/lib/openapi_openai/models/create_fine_tuning_job_request_hyperparameters_n_epochs.rb +106 -0
- data/lib/openapi_openai/models/{list_fine_tunes_response.rb → create_fine_tuning_job_request_integrations_inner.rb} +25 -27
- data/lib/openapi_openai/models/create_fine_tuning_job_request_integrations_inner_type.rb +105 -0
- data/lib/openapi_openai/models/create_fine_tuning_job_request_integrations_inner_wandb.rb +257 -0
- data/lib/openapi_openai/models/create_fine_tuning_job_request_model.rb +104 -0
- data/lib/openapi_openai/models/create_image_edit_request_model.rb +104 -0
- data/lib/openapi_openai/models/create_image_request.rb +81 -22
- data/lib/openapi_openai/models/create_image_request_model.rb +104 -0
- data/lib/openapi_openai/models/create_message_request.rb +352 -0
- data/lib/openapi_openai/models/create_moderation_request.rb +1 -1
- data/lib/openapi_openai/models/create_moderation_request_input.rb +1 -1
- data/lib/openapi_openai/models/create_moderation_request_model.rb +8 -9
- data/lib/openapi_openai/models/create_moderation_response.rb +5 -1
- data/lib/openapi_openai/models/create_moderation_response_results_inner.rb +2 -1
- data/lib/openapi_openai/models/create_moderation_response_results_inner_categories.rb +78 -2
- data/lib/openapi_openai/models/create_moderation_response_results_inner_category_scores.rb +78 -2
- data/lib/openapi_openai/models/create_run_request.rb +433 -0
- data/lib/openapi_openai/models/create_run_request_model.rb +104 -0
- data/lib/openapi_openai/models/{create_edit_request.rb → create_speech_request.rb} +105 -95
- data/lib/openapi_openai/models/create_speech_request_model.rb +104 -0
- data/lib/openapi_openai/models/create_thread_and_run_request.rb +418 -0
- data/lib/openapi_openai/models/create_thread_and_run_request_tools_inner.rb +106 -0
- data/lib/openapi_openai/models/{list_fine_tune_events_response.rb → create_thread_request.rb} +22 -33
- data/lib/openapi_openai/models/create_transcription200_response.rb +105 -0
- data/lib/openapi_openai/models/create_transcription_request_model.rb +9 -10
- data/lib/openapi_openai/models/{create_transcription_response.rb → create_transcription_response_json.rb} +6 -4
- data/lib/openapi_openai/models/create_transcription_response_verbose_json.rb +281 -0
- data/lib/openapi_openai/models/create_translation200_response.rb +105 -0
- data/lib/openapi_openai/models/{create_translation_response.rb → create_translation_response_json.rb} +4 -4
- data/lib/openapi_openai/models/create_translation_response_verbose_json.rb +268 -0
- data/lib/openapi_openai/models/delete_assistant_file_response.rb +288 -0
- data/lib/openapi_openai/models/delete_assistant_response.rb +287 -0
- data/lib/openapi_openai/models/delete_file_response.rb +35 -1
- data/lib/openapi_openai/models/delete_message_response.rb +287 -0
- data/lib/openapi_openai/models/delete_model_response.rb +21 -21
- data/lib/openapi_openai/models/delete_thread_response.rb +287 -0
- data/lib/openapi_openai/models/done_event.rb +284 -0
- data/lib/openapi_openai/models/embedding.rb +293 -0
- data/lib/openapi_openai/models/error.rb +22 -22
- data/lib/openapi_openai/models/error_event.rb +272 -0
- data/lib/openapi_openai/models/error_response.rb +1 -1
- data/lib/openapi_openai/models/fine_tuning_integration.rb +272 -0
- data/lib/openapi_openai/models/fine_tuning_job.rb +515 -0
- data/lib/openapi_openai/models/{fine_tune.rb → fine_tuning_job_checkpoint.rb} +94 -146
- data/lib/openapi_openai/models/fine_tuning_job_checkpoint_metrics.rb +269 -0
- data/lib/openapi_openai/models/{fine_tune_event.rb → fine_tuning_job_error.rb} +34 -50
- data/lib/openapi_openai/models/fine_tuning_job_event.rb +332 -0
- data/lib/openapi_openai/models/fine_tuning_job_hyperparameters.rb +222 -0
- data/lib/openapi_openai/models/fine_tuning_job_hyperparameters_n_epochs.rb +106 -0
- data/lib/openapi_openai/models/{create_edit_request_model.rb → fine_tuning_job_integrations_inner.rb} +3 -4
- data/lib/openapi_openai/models/function_object.rb +244 -0
- data/lib/openapi_openai/models/image.rb +236 -0
- data/lib/openapi_openai/models/images_response.rb +2 -2
- data/lib/openapi_openai/models/list_assistant_files_response.rb +287 -0
- data/lib/openapi_openai/models/list_assistants_response.rb +287 -0
- data/lib/openapi_openai/models/list_files_response.rb +54 -20
- data/lib/openapi_openai/models/list_fine_tuning_job_checkpoints_response.rb +309 -0
- data/lib/openapi_openai/models/{create_edit_response.rb → list_fine_tuning_job_events_response.rb} +57 -55
- data/lib/openapi_openai/models/list_message_files_response.rb +287 -0
- data/lib/openapi_openai/models/list_messages_response.rb +287 -0
- data/lib/openapi_openai/models/list_models_response.rb +35 -1
- data/lib/openapi_openai/models/list_paginated_fine_tuning_jobs_response.rb +289 -0
- data/lib/openapi_openai/models/list_run_steps_response.rb +287 -0
- data/lib/openapi_openai/models/list_runs_response.rb +287 -0
- data/lib/openapi_openai/models/list_threads_response.rb +287 -0
- data/lib/openapi_openai/models/message_content_image_file_object.rb +273 -0
- data/lib/openapi_openai/models/message_content_image_file_object_image_file.rb +222 -0
- data/lib/openapi_openai/models/message_content_text_annotations_file_citation_object.rb +360 -0
- data/lib/openapi_openai/models/message_content_text_annotations_file_citation_object_file_citation.rb +239 -0
- data/lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb +360 -0
- data/lib/openapi_openai/models/message_content_text_annotations_file_path_object_file_path.rb +222 -0
- data/lib/openapi_openai/models/message_content_text_object.rb +273 -0
- data/lib/openapi_openai/models/message_content_text_object_text.rb +240 -0
- data/lib/openapi_openai/models/message_content_text_object_text_annotations_inner.rb +105 -0
- data/lib/openapi_openai/models/message_delta_content_image_file_object.rb +283 -0
- data/lib/openapi_openai/models/message_delta_content_image_file_object_image_file.rb +215 -0
- data/lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb +349 -0
- data/lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object_file_citation.rb +225 -0
- data/lib/openapi_openai/models/message_delta_content_text_annotations_file_path_object.rb +349 -0
- data/lib/openapi_openai/models/message_delta_content_text_annotations_file_path_object_file_path.rb +215 -0
- data/lib/openapi_openai/models/{create_edit_response_choices_inner.rb → message_delta_content_text_object.rb} +42 -35
- data/lib/openapi_openai/models/message_delta_content_text_object_text.rb +226 -0
- data/lib/openapi_openai/models/message_delta_content_text_object_text_annotations_inner.rb +105 -0
- data/lib/openapi_openai/models/message_delta_object.rb +290 -0
- data/lib/openapi_openai/models/message_delta_object_delta.rb +293 -0
- data/lib/openapi_openai/models/message_delta_object_delta_content_inner.rb +105 -0
- data/lib/openapi_openai/models/message_file_object.rb +308 -0
- data/lib/openapi_openai/models/message_object.rb +500 -0
- data/lib/openapi_openai/models/message_object_content_inner.rb +105 -0
- data/lib/openapi_openai/models/message_object_incomplete_details.rb +257 -0
- data/lib/openapi_openai/models/message_stream_event.rb +108 -0
- data/lib/openapi_openai/models/message_stream_event_one_of.rb +272 -0
- data/lib/openapi_openai/models/message_stream_event_one_of1.rb +272 -0
- data/lib/openapi_openai/models/message_stream_event_one_of2.rb +272 -0
- data/lib/openapi_openai/models/message_stream_event_one_of3.rb +272 -0
- data/lib/openapi_openai/models/message_stream_event_one_of4.rb +272 -0
- data/lib/openapi_openai/models/model.rb +57 -18
- data/lib/openapi_openai/models/modify_assistant_request.rb +365 -0
- data/lib/openapi_openai/models/modify_message_request.rb +216 -0
- data/lib/openapi_openai/models/modify_run_request.rb +216 -0
- data/lib/openapi_openai/models/modify_thread_request.rb +216 -0
- data/lib/openapi_openai/models/open_ai_file.rb +93 -20
- data/lib/openapi_openai/models/run_completion_usage.rb +257 -0
- data/lib/openapi_openai/models/run_object.rb +686 -0
- data/lib/openapi_openai/models/run_object_incomplete_details.rb +250 -0
- data/lib/openapi_openai/models/run_object_last_error.rb +274 -0
- data/lib/openapi_openai/models/run_object_required_action.rb +273 -0
- data/lib/openapi_openai/models/run_object_required_action_submit_tool_outputs.rb +225 -0
- data/lib/openapi_openai/models/run_step_completion_usage.rb +257 -0
- data/lib/openapi_openai/models/run_step_delta_object.rb +290 -0
- data/lib/openapi_openai/models/{images_response_data_inner.rb → run_step_delta_object_delta.rb} +12 -20
- data/lib/openapi_openai/models/run_step_delta_object_delta_step_details.rb +106 -0
- data/lib/openapi_openai/models/run_step_delta_step_details_message_creation_object.rb +266 -0
- data/lib/openapi_openai/models/run_step_delta_step_details_message_creation_object_message_creation.rb +215 -0
- data/lib/openapi_openai/models/run_step_delta_step_details_tool_calls_code_object.rb +293 -0
- data/lib/openapi_openai/models/run_step_delta_step_details_tool_calls_code_object_code_interpreter.rb +228 -0
- data/lib/openapi_openai/models/run_step_delta_step_details_tool_calls_code_object_code_interpreter_outputs_inner.rb +105 -0
- data/lib/openapi_openai/models/run_step_delta_step_details_tool_calls_code_output_image_object.rb +282 -0
- data/lib/openapi_openai/models/run_step_delta_step_details_tool_calls_code_output_image_object_image.rb +215 -0
- data/lib/openapi_openai/models/run_step_delta_step_details_tool_calls_code_output_logs_object.rb +284 -0
- data/lib/openapi_openai/models/run_step_delta_step_details_tool_calls_function_object.rb +292 -0
- data/lib/openapi_openai/models/run_step_delta_step_details_tool_calls_function_object_function.rb +237 -0
- data/lib/openapi_openai/models/run_step_delta_step_details_tool_calls_object.rb +269 -0
- data/lib/openapi_openai/models/run_step_delta_step_details_tool_calls_object_tool_calls_inner.rb +106 -0
- data/lib/openapi_openai/models/run_step_delta_step_details_tool_calls_retrieval_object.rb +293 -0
- data/lib/openapi_openai/models/run_step_details_message_creation_object.rb +273 -0
- data/lib/openapi_openai/models/run_step_details_message_creation_object_message_creation.rb +222 -0
- data/lib/openapi_openai/models/run_step_details_tool_calls_code_object.rb +290 -0
- data/lib/openapi_openai/models/run_step_details_tool_calls_code_object_code_interpreter.rb +242 -0
- data/lib/openapi_openai/models/run_step_details_tool_calls_code_object_code_interpreter_outputs_inner.rb +105 -0
- data/lib/openapi_openai/models/run_step_details_tool_calls_code_output_image_object.rb +272 -0
- data/lib/openapi_openai/models/run_step_details_tool_calls_code_output_image_object_image.rb +222 -0
- data/lib/openapi_openai/models/run_step_details_tool_calls_code_output_logs_object.rb +274 -0
- data/lib/openapi_openai/models/run_step_details_tool_calls_function_object.rb +289 -0
- data/lib/openapi_openai/models/run_step_details_tool_calls_function_object_function.rb +253 -0
- data/lib/openapi_openai/models/run_step_details_tool_calls_object.rb +276 -0
- data/lib/openapi_openai/models/run_step_details_tool_calls_object_tool_calls_inner.rb +106 -0
- data/lib/openapi_openai/models/run_step_details_tool_calls_retrieval_object.rb +290 -0
- data/lib/openapi_openai/models/run_step_object.rb +505 -0
- data/lib/openapi_openai/models/run_step_object_last_error.rb +274 -0
- data/lib/openapi_openai/models/run_step_object_step_details.rb +106 -0
- data/lib/openapi_openai/models/run_step_stream_event.rb +110 -0
- data/lib/openapi_openai/models/run_step_stream_event_one_of.rb +272 -0
- data/lib/openapi_openai/models/run_step_stream_event_one_of1.rb +272 -0
- data/lib/openapi_openai/models/run_step_stream_event_one_of2.rb +272 -0
- data/lib/openapi_openai/models/run_step_stream_event_one_of3.rb +272 -0
- data/lib/openapi_openai/models/run_step_stream_event_one_of4.rb +272 -0
- data/lib/openapi_openai/models/run_step_stream_event_one_of5.rb +272 -0
- data/lib/openapi_openai/models/run_step_stream_event_one_of6.rb +272 -0
- data/lib/openapi_openai/models/run_stream_event.rb +112 -0
- data/lib/openapi_openai/models/run_stream_event_one_of.rb +272 -0
- data/lib/openapi_openai/models/run_stream_event_one_of1.rb +272 -0
- data/lib/openapi_openai/models/run_stream_event_one_of2.rb +272 -0
- data/lib/openapi_openai/models/run_stream_event_one_of3.rb +272 -0
- data/lib/openapi_openai/models/run_stream_event_one_of4.rb +272 -0
- data/lib/openapi_openai/models/run_stream_event_one_of5.rb +272 -0
- data/lib/openapi_openai/models/run_stream_event_one_of6.rb +272 -0
- data/lib/openapi_openai/models/run_stream_event_one_of7.rb +272 -0
- data/lib/openapi_openai/models/run_stream_event_one_of8.rb +272 -0
- data/lib/openapi_openai/models/run_tool_call_object.rb +290 -0
- data/lib/openapi_openai/models/run_tool_call_object_function.rb +240 -0
- data/lib/openapi_openai/models/submit_tool_outputs_run_request.rb +235 -0
- data/lib/openapi_openai/models/submit_tool_outputs_run_request_tool_outputs_inner.rb +225 -0
- data/lib/openapi_openai/models/thread_object.rb +304 -0
- data/lib/openapi_openai/models/thread_stream_event.rb +104 -0
- data/lib/openapi_openai/models/thread_stream_event_one_of.rb +272 -0
- data/lib/openapi_openai/models/transcription_segment.rb +377 -0
- data/lib/openapi_openai/models/{create_embedding_response_data_inner.rb → transcription_word.rb} +38 -37
- data/lib/openapi_openai/models/truncation_object.rb +275 -0
- data/lib/openapi_openai/version.rb +2 -2
- data/lib/openapi_openai.rb +209 -19
- data/openapi_openai.gemspec +2 -2
- data/spec/api/assistants_api_spec.rb +389 -0
- data/spec/api/audio_api_spec.rb +78 -0
- data/spec/api/chat_api_spec.rb +46 -0
- data/spec/api/completions_api_spec.rb +46 -0
- data/spec/api/embeddings_api_spec.rb +46 -0
- data/spec/api/files_api_spec.rb +91 -0
- data/spec/api/fine_tuning_api_spec.rb +106 -0
- data/spec/api/images_api_spec.rb +80 -0
- data/spec/api/models_api_spec.rb +67 -0
- data/spec/api/moderations_api_spec.rb +46 -0
- data/spec/models/assistant_file_object_spec.rb +58 -0
- data/spec/models/assistant_object_spec.rb +94 -0
- data/spec/models/assistant_object_tools_inner_spec.rb +32 -0
- data/spec/models/assistant_stream_event_spec.rb +32 -0
- data/spec/models/assistant_tools_code_spec.rb +40 -0
- data/spec/models/assistant_tools_function_spec.rb +46 -0
- data/spec/models/assistant_tools_retrieval_spec.rb +40 -0
- data/spec/models/assistants_api_named_tool_choice_spec.rb +46 -0
- data/spec/models/assistants_api_response_format_option_spec.rb +32 -0
- data/spec/models/assistants_api_response_format_spec.rb +40 -0
- data/spec/models/assistants_api_tool_choice_option_spec.rb +32 -0
- data/spec/models/chat_completion_function_call_option_spec.rb +36 -0
- data/spec/models/chat_completion_functions_spec.rb +3 -3
- data/spec/models/chat_completion_message_tool_call_chunk_function_spec.rb +42 -0
- data/spec/models/{create_edit_response_choices_inner_spec.rb → chat_completion_message_tool_call_chunk_spec.rb} +15 -15
- data/spec/models/{chat_completion_request_message_function_call_spec.rb → chat_completion_message_tool_call_function_spec.rb} +7 -7
- data/spec/models/chat_completion_message_tool_call_spec.rb +52 -0
- data/spec/models/chat_completion_named_tool_choice_function_spec.rb +36 -0
- data/spec/models/chat_completion_named_tool_choice_spec.rb +46 -0
- data/spec/models/chat_completion_request_assistant_message_function_call_spec.rb +42 -0
- data/spec/models/chat_completion_request_assistant_message_spec.rb +64 -0
- data/spec/models/chat_completion_request_function_message_spec.rb +52 -0
- data/spec/models/chat_completion_request_message_content_part_image_image_url_spec.rb +46 -0
- data/spec/models/chat_completion_request_message_content_part_image_spec.rb +46 -0
- data/spec/models/chat_completion_request_message_content_part_spec.rb +32 -0
- data/spec/models/chat_completion_request_message_content_part_text_spec.rb +46 -0
- data/spec/models/chat_completion_request_message_spec.rb +6 -32
- data/spec/models/chat_completion_request_system_message_spec.rb +52 -0
- data/spec/models/chat_completion_request_tool_message_spec.rb +52 -0
- data/spec/models/chat_completion_request_user_message_content_spec.rb +32 -0
- data/spec/models/chat_completion_request_user_message_spec.rb +52 -0
- data/spec/models/chat_completion_response_message_spec.rb +13 -7
- data/spec/models/chat_completion_role_spec.rb +30 -0
- data/spec/models/chat_completion_stream_response_delta_function_call_spec.rb +42 -0
- data/spec/models/chat_completion_stream_response_delta_spec.rb +14 -8
- data/spec/models/{create_edit_response_spec.rb → chat_completion_token_logprob_spec.rb} +11 -11
- data/spec/models/chat_completion_token_logprob_top_logprobs_inner_spec.rb +48 -0
- data/spec/models/chat_completion_tool_choice_option_spec.rb +32 -0
- data/spec/models/chat_completion_tool_spec.rb +46 -0
- data/spec/models/{create_completion_response_usage_spec.rb → completion_usage_spec.rb} +9 -9
- data/spec/models/create_assistant_file_request_spec.rb +36 -0
- data/spec/models/create_assistant_request_model_spec.rb +21 -0
- data/spec/models/{create_edit_request_spec.rb → create_assistant_request_spec.rb} +18 -12
- data/spec/models/create_chat_completion_function_response_choices_inner_spec.rb +52 -0
- data/spec/models/create_chat_completion_function_response_spec.rb +76 -0
- data/spec/models/create_chat_completion_request_function_call_spec.rb +1 -1
- data/spec/models/create_chat_completion_request_model_spec.rb +1 -12
- data/spec/models/{create_chat_completion_request_function_call_one_of_spec.rb → create_chat_completion_request_response_format_spec.rb} +12 -8
- data/spec/models/create_chat_completion_request_spec.rb +47 -11
- data/spec/models/create_chat_completion_request_stop_spec.rb +1 -1
- data/spec/models/create_chat_completion_response_choices_inner_logprobs_spec.rb +36 -0
- data/spec/models/create_chat_completion_response_choices_inner_spec.rb +12 -6
- data/spec/models/create_chat_completion_response_spec.rb +13 -3
- data/spec/models/create_chat_completion_stream_response_choices_inner_spec.rb +10 -4
- data/spec/models/create_chat_completion_stream_response_spec.rb +13 -3
- data/spec/models/create_completion_request_model_spec.rb +1 -12
- data/spec/models/create_completion_request_prompt_spec.rb +1 -1
- data/spec/models/create_completion_request_spec.rb +19 -13
- data/spec/models/create_completion_request_stop_spec.rb +1 -1
- data/spec/models/create_completion_response_choices_inner_logprobs_spec.rb +4 -4
- data/spec/models/create_completion_response_choices_inner_spec.rb +7 -7
- data/spec/models/create_completion_response_spec.rb +13 -3
- data/spec/models/create_embedding_request_input_spec.rb +1 -1
- data/spec/models/create_embedding_request_model_spec.rb +1 -12
- data/spec/models/create_embedding_request_spec.rb +18 -2
- data/spec/models/create_embedding_response_spec.rb +7 -3
- data/spec/models/create_embedding_response_usage_spec.rb +1 -1
- data/spec/models/create_fine_tuning_job_request_hyperparameters_batch_size_spec.rb +32 -0
- data/spec/models/create_fine_tuning_job_request_hyperparameters_learning_rate_multiplier_spec.rb +32 -0
- data/spec/models/create_fine_tuning_job_request_hyperparameters_n_epochs_spec.rb +32 -0
- data/spec/models/create_fine_tuning_job_request_hyperparameters_spec.rb +48 -0
- data/spec/models/create_fine_tuning_job_request_integrations_inner_spec.rb +42 -0
- data/spec/models/create_fine_tuning_job_request_integrations_inner_type_spec.rb +32 -0
- data/spec/models/create_fine_tuning_job_request_integrations_inner_wandb_spec.rb +54 -0
- data/spec/models/create_fine_tuning_job_request_model_spec.rb +21 -0
- data/spec/models/create_fine_tuning_job_request_spec.rb +72 -0
- data/spec/models/create_image_edit_request_model_spec.rb +21 -0
- data/spec/models/create_image_request_model_spec.rb +21 -0
- data/spec/models/create_image_request_spec.rb +30 -4
- data/spec/models/create_message_request_spec.rb +58 -0
- data/spec/models/create_moderation_request_input_spec.rb +1 -1
- data/spec/models/create_moderation_request_model_spec.rb +1 -12
- data/spec/models/create_moderation_request_spec.rb +1 -1
- data/spec/models/create_moderation_response_results_inner_categories_spec.rb +25 -1
- data/spec/models/create_moderation_response_results_inner_category_scores_spec.rb +25 -1
- data/spec/models/create_moderation_response_results_inner_spec.rb +1 -1
- data/spec/models/create_moderation_response_spec.rb +1 -1
- data/spec/models/create_run_request_model_spec.rb +21 -0
- data/spec/models/{create_fine_tune_request_spec.rb → create_run_request_spec.rb} +31 -19
- data/spec/models/create_speech_request_model_spec.rb +21 -0
- data/spec/models/create_speech_request_spec.rb +68 -0
- data/spec/models/{fine_tune_spec.rb → create_thread_and_run_request_spec.rb} +20 -20
- data/spec/models/create_thread_and_run_request_tools_inner_spec.rb +32 -0
- data/spec/models/{list_fine_tune_events_response_spec.rb → create_thread_request_spec.rb} +9 -9
- data/spec/models/create_transcription200_response_spec.rb +32 -0
- data/spec/models/create_transcription_request_model_spec.rb +1 -12
- data/spec/models/{create_transcription_response_spec.rb → create_transcription_response_json_spec.rb} +7 -7
- data/spec/models/create_transcription_response_verbose_json_spec.rb +60 -0
- data/spec/models/create_translation200_response_spec.rb +32 -0
- data/spec/models/{create_translation_response_spec.rb → create_translation_response_json_spec.rb} +7 -7
- data/spec/models/create_translation_response_verbose_json_spec.rb +54 -0
- data/spec/models/delete_assistant_file_response_spec.rb +52 -0
- data/spec/models/delete_assistant_response_spec.rb +52 -0
- data/spec/models/delete_file_response_spec.rb +5 -1
- data/spec/models/delete_message_response_spec.rb +52 -0
- data/spec/models/delete_model_response_spec.rb +3 -3
- data/spec/models/delete_thread_response_spec.rb +52 -0
- data/spec/models/done_event_spec.rb +50 -0
- data/spec/models/{create_embedding_response_data_inner_spec.rb → embedding_spec.rb} +13 -9
- data/spec/models/error_event_spec.rb +46 -0
- data/spec/models/error_response_spec.rb +1 -1
- data/spec/models/error_spec.rb +3 -3
- data/spec/models/fine_tuning_integration_spec.rb +46 -0
- data/spec/models/fine_tuning_job_checkpoint_metrics_spec.rb +72 -0
- data/spec/models/fine_tuning_job_checkpoint_spec.rb +76 -0
- data/spec/models/{fine_tune_event_spec.rb → fine_tuning_job_error_spec.rb} +10 -16
- data/spec/models/fine_tuning_job_event_spec.rb +68 -0
- data/spec/models/fine_tuning_job_hyperparameters_n_epochs_spec.rb +32 -0
- data/spec/models/fine_tuning_job_hyperparameters_spec.rb +36 -0
- data/spec/models/fine_tuning_job_integrations_inner_spec.rb +32 -0
- data/spec/models/fine_tuning_job_spec.rb +134 -0
- data/spec/models/function_object_spec.rb +48 -0
- data/spec/models/{images_response_data_inner_spec.rb → image_spec.rb} +14 -8
- data/spec/models/images_response_spec.rb +1 -1
- data/spec/models/list_assistant_files_response_spec.rb +60 -0
- data/spec/models/list_assistants_response_spec.rb +60 -0
- data/spec/models/list_files_response_spec.rb +7 -3
- data/spec/models/list_fine_tuning_job_checkpoints_response_spec.rb +64 -0
- data/spec/models/{list_fine_tunes_response_spec.rb → list_fine_tuning_job_events_response_spec.rb} +13 -9
- data/spec/models/list_message_files_response_spec.rb +60 -0
- data/spec/models/list_messages_response_spec.rb +60 -0
- data/spec/models/list_models_response_spec.rb +5 -1
- data/spec/models/list_paginated_fine_tuning_jobs_response_spec.rb +52 -0
- data/spec/models/list_run_steps_response_spec.rb +60 -0
- data/spec/models/list_runs_response_spec.rb +60 -0
- data/spec/models/list_threads_response_spec.rb +60 -0
- data/spec/models/message_content_image_file_object_image_file_spec.rb +36 -0
- data/spec/models/message_content_image_file_object_spec.rb +46 -0
- data/spec/models/message_content_text_annotations_file_citation_object_file_citation_spec.rb +42 -0
- data/spec/models/message_content_text_annotations_file_citation_object_spec.rb +64 -0
- data/spec/models/message_content_text_annotations_file_path_object_file_path_spec.rb +36 -0
- data/spec/models/message_content_text_annotations_file_path_object_spec.rb +64 -0
- data/spec/models/message_content_text_object_spec.rb +46 -0
- data/spec/models/message_content_text_object_text_annotations_inner_spec.rb +32 -0
- data/spec/models/message_content_text_object_text_spec.rb +42 -0
- data/spec/models/message_delta_content_image_file_object_image_file_spec.rb +36 -0
- data/spec/models/message_delta_content_image_file_object_spec.rb +52 -0
- data/spec/models/message_delta_content_text_annotations_file_citation_object_file_citation_spec.rb +42 -0
- data/spec/models/message_delta_content_text_annotations_file_citation_object_spec.rb +70 -0
- data/spec/models/message_delta_content_text_annotations_file_path_object_file_path_spec.rb +36 -0
- data/spec/models/message_delta_content_text_annotations_file_path_object_spec.rb +70 -0
- data/spec/models/message_delta_content_text_object_spec.rb +52 -0
- data/spec/models/message_delta_content_text_object_text_annotations_inner_spec.rb +32 -0
- data/spec/models/message_delta_content_text_object_text_spec.rb +42 -0
- data/spec/models/message_delta_object_delta_content_inner_spec.rb +32 -0
- data/spec/models/message_delta_object_delta_spec.rb +52 -0
- data/spec/models/message_delta_object_spec.rb +52 -0
- data/spec/models/message_file_object_spec.rb +58 -0
- data/spec/models/message_object_content_inner_spec.rb +32 -0
- data/spec/models/message_object_incomplete_details_spec.rb +40 -0
- data/spec/models/message_object_spec.rb +126 -0
- data/spec/models/message_stream_event_one_of1_spec.rb +46 -0
- data/spec/models/message_stream_event_one_of2_spec.rb +46 -0
- data/spec/models/message_stream_event_one_of3_spec.rb +46 -0
- data/spec/models/message_stream_event_one_of4_spec.rb +46 -0
- data/spec/models/message_stream_event_one_of_spec.rb +46 -0
- data/spec/models/message_stream_event_spec.rb +32 -0
- data/spec/models/model_spec.rb +7 -3
- data/spec/models/modify_assistant_request_spec.rb +72 -0
- data/spec/models/modify_message_request_spec.rb +36 -0
- data/spec/models/modify_run_request_spec.rb +36 -0
- data/spec/models/modify_thread_request_spec.rb +36 -0
- data/spec/models/open_ai_file_spec.rb +17 -5
- data/spec/models/run_completion_usage_spec.rb +48 -0
- data/spec/models/run_object_incomplete_details_spec.rb +40 -0
- data/spec/models/run_object_last_error_spec.rb +46 -0
- data/spec/models/run_object_required_action_spec.rb +46 -0
- data/spec/models/run_object_required_action_submit_tool_outputs_spec.rb +36 -0
- data/spec/models/run_object_spec.rb +194 -0
- data/spec/models/run_step_completion_usage_spec.rb +48 -0
- data/spec/models/run_step_delta_object_delta_spec.rb +36 -0
- data/spec/models/run_step_delta_object_delta_step_details_spec.rb +32 -0
- data/spec/models/run_step_delta_object_spec.rb +52 -0
- data/spec/models/run_step_delta_step_details_message_creation_object_message_creation_spec.rb +36 -0
- data/spec/models/run_step_delta_step_details_message_creation_object_spec.rb +46 -0
- data/spec/models/run_step_delta_step_details_tool_calls_code_object_code_interpreter_outputs_inner_spec.rb +32 -0
- data/spec/models/run_step_delta_step_details_tool_calls_code_object_code_interpreter_spec.rb +42 -0
- data/spec/models/run_step_delta_step_details_tool_calls_code_object_spec.rb +58 -0
- data/spec/models/run_step_delta_step_details_tool_calls_code_output_image_object_image_spec.rb +36 -0
- data/spec/models/run_step_delta_step_details_tool_calls_code_output_image_object_spec.rb +52 -0
- data/spec/models/run_step_delta_step_details_tool_calls_code_output_logs_object_spec.rb +52 -0
- data/spec/models/run_step_delta_step_details_tool_calls_function_object_function_spec.rb +48 -0
- data/spec/models/run_step_delta_step_details_tool_calls_function_object_spec.rb +58 -0
- data/spec/models/run_step_delta_step_details_tool_calls_object_spec.rb +46 -0
- data/spec/models/run_step_delta_step_details_tool_calls_object_tool_calls_inner_spec.rb +32 -0
- data/spec/models/run_step_delta_step_details_tool_calls_retrieval_object_spec.rb +58 -0
- data/spec/models/run_step_details_message_creation_object_message_creation_spec.rb +36 -0
- data/spec/models/run_step_details_message_creation_object_spec.rb +46 -0
- data/spec/models/run_step_details_tool_calls_code_object_code_interpreter_outputs_inner_spec.rb +32 -0
- data/spec/models/run_step_details_tool_calls_code_object_code_interpreter_spec.rb +42 -0
- data/spec/models/run_step_details_tool_calls_code_object_spec.rb +52 -0
- data/spec/models/run_step_details_tool_calls_code_output_image_object_image_spec.rb +36 -0
- data/spec/models/run_step_details_tool_calls_code_output_image_object_spec.rb +46 -0
- data/spec/models/run_step_details_tool_calls_code_output_logs_object_spec.rb +46 -0
- data/spec/models/run_step_details_tool_calls_function_object_function_spec.rb +48 -0
- data/spec/models/run_step_details_tool_calls_function_object_spec.rb +52 -0
- data/spec/models/run_step_details_tool_calls_object_spec.rb +46 -0
- data/spec/models/run_step_details_tool_calls_object_tool_calls_inner_spec.rb +32 -0
- data/spec/models/run_step_details_tool_calls_retrieval_object_spec.rb +52 -0
- data/spec/models/run_step_object_last_error_spec.rb +46 -0
- data/spec/models/run_step_object_spec.rb +138 -0
- data/spec/models/run_step_object_step_details_spec.rb +32 -0
- data/spec/models/run_step_stream_event_one_of1_spec.rb +46 -0
- data/spec/models/run_step_stream_event_one_of2_spec.rb +46 -0
- data/spec/models/run_step_stream_event_one_of3_spec.rb +46 -0
- data/spec/models/run_step_stream_event_one_of4_spec.rb +46 -0
- data/spec/models/run_step_stream_event_one_of5_spec.rb +46 -0
- data/spec/models/run_step_stream_event_one_of6_spec.rb +46 -0
- data/spec/models/run_step_stream_event_one_of_spec.rb +46 -0
- data/spec/models/run_step_stream_event_spec.rb +32 -0
- data/spec/models/run_stream_event_one_of1_spec.rb +46 -0
- data/spec/models/run_stream_event_one_of2_spec.rb +46 -0
- data/spec/models/run_stream_event_one_of3_spec.rb +46 -0
- data/spec/models/run_stream_event_one_of4_spec.rb +46 -0
- data/spec/models/run_stream_event_one_of5_spec.rb +46 -0
- data/spec/models/run_stream_event_one_of6_spec.rb +46 -0
- data/spec/models/run_stream_event_one_of7_spec.rb +46 -0
- data/spec/models/run_stream_event_one_of8_spec.rb +46 -0
- data/spec/models/run_stream_event_one_of_spec.rb +46 -0
- data/spec/models/{create_fine_tune_request_model_spec.rb → run_stream_event_spec.rb} +3 -3
- data/spec/models/run_tool_call_object_function_spec.rb +42 -0
- data/spec/models/run_tool_call_object_spec.rb +52 -0
- data/spec/models/submit_tool_outputs_run_request_spec.rb +42 -0
- data/spec/models/submit_tool_outputs_run_request_tool_outputs_inner_spec.rb +42 -0
- data/spec/models/thread_object_spec.rb +58 -0
- data/spec/models/thread_stream_event_one_of_spec.rb +46 -0
- data/spec/models/{create_edit_request_model_spec.rb → thread_stream_event_spec.rb} +3 -3
- data/spec/models/transcription_segment_spec.rb +90 -0
- data/spec/models/transcription_word_spec.rb +48 -0
- data/spec/models/truncation_object_spec.rb +46 -0
- data/spec/spec_helper.rb +1 -1
- metadata +867 -106
- data/docs/CreateCompletionResponseUsage.md +0 -22
- data/docs/CreateEditRequest.md +0 -28
- data/docs/CreateEditResponse.md +0 -24
- data/docs/CreateEditResponseChoicesInner.md +0 -24
- data/docs/CreateEmbeddingResponseDataInner.md +0 -22
- data/docs/CreateFineTuneRequest.md +0 -40
- data/docs/CreateTranslationResponse.md +0 -18
- data/docs/FineTune.md +0 -42
- data/docs/ImagesResponseDataInner.md +0 -20
- data/docs/ListFineTuneEventsResponse.md +0 -20
- data/docs/ListFineTunesResponse.md +0 -20
- data/docs/OpenAIApi.md +0 -1499
- data/lib/openapi_openai/api/open_ai_api.rb +0 -1583
- data/spec/api/open_ai_api_spec.rb +0 -306
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 623c0b41b12b74208110d8f48574ec6bade69602eb8e827bb9d95a9dace9778c
|
|
4
|
+
data.tar.gz: 0b8e370c25440c6cc43d9a2c4c2b37607d63cc5ef92b89e5d9eb81a06abc42d5
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0b04622b6c896b6da3bcea08d6a3417f440ead4bbee42806f8342f0a9efa224668c3f93229ebeef435b7874ef0ee153ae7685e112ea5b5f9a98f35ba3cca25a3
|
|
7
|
+
data.tar.gz: 8a6c3aa1b59fa177b7ed058d6c2812aa93f79594138a72d4bcff28e1cee7fa2ad3f887e846ceb6f480c018bbea0de9b3f7d4d3df21ccaccc1e72fb268fb07a7a
|
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
openapi_openai (1.
|
|
4
|
+
openapi_openai (1.1.0)
|
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
|
6
6
|
|
|
7
7
|
GEM
|
|
@@ -15,7 +15,7 @@ GEM
|
|
|
15
15
|
ffi (>= 1.15.0)
|
|
16
16
|
ffi (1.16.3)
|
|
17
17
|
jaro_winkler (1.5.6)
|
|
18
|
-
method_source (1.
|
|
18
|
+
method_source (1.1.0)
|
|
19
19
|
parallel (1.24.0)
|
|
20
20
|
parser (3.3.0.5)
|
|
21
21
|
ast (~> 2.4.1)
|
data/README.md
CHANGED
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
OpenApiOpenAIClient - the Ruby gem for the OpenAI API
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
|
|
6
6
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
9
|
- API version: 2.0.0
|
|
10
|
-
- Package version: 1.
|
|
10
|
+
- Package version: 1.1.0
|
|
11
11
|
- Generator version: 7.4.0
|
|
12
12
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
13
13
|
For more information, please visit [https://github.com/oapicf/openapi-openai](https://github.com/oapicf/openapi-openai)
|
|
@@ -25,16 +25,16 @@ gem build openapi_openai.gemspec
|
|
|
25
25
|
Then either install the gem locally:
|
|
26
26
|
|
|
27
27
|
```shell
|
|
28
|
-
gem install ./openapi_openai-1.
|
|
28
|
+
gem install ./openapi_openai-1.1.0.gem
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
(for development, run `gem install --dev ./openapi_openai-1.
|
|
31
|
+
(for development, run `gem install --dev ./openapi_openai-1.1.0.gem` to install the development dependencies)
|
|
32
32
|
|
|
33
33
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
34
34
|
|
|
35
35
|
Finally add this to the Gemfile:
|
|
36
36
|
|
|
37
|
-
gem 'openapi_openai', '~> 1.
|
|
37
|
+
gem 'openapi_openai', '~> 1.1.0'
|
|
38
38
|
|
|
39
39
|
### Install from Git
|
|
40
40
|
|
|
@@ -58,15 +58,24 @@ Please follow the [installation](#installation) procedure and then run the follo
|
|
|
58
58
|
# Load the gem
|
|
59
59
|
require 'openapi_openai'
|
|
60
60
|
|
|
61
|
-
|
|
62
|
-
|
|
61
|
+
# Setup authorization
|
|
62
|
+
OpenApiOpenAIClient.configure do |config|
|
|
63
|
+
# Configure Bearer authorization: ApiKeyAuth
|
|
64
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
65
|
+
# Configure a proc to get access tokens in lieu of the static access_token configuration
|
|
66
|
+
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
api_instance = OpenApiOpenAIClient::AssistantsApi.new
|
|
70
|
+
thread_id = 'thread_id_example' # String | The ID of the thread to which this run belongs.
|
|
71
|
+
run_id = 'run_id_example' # String | The ID of the run to cancel.
|
|
63
72
|
|
|
64
73
|
begin
|
|
65
|
-
#
|
|
66
|
-
result = api_instance.
|
|
74
|
+
#Cancels a run that is `in_progress`.
|
|
75
|
+
result = api_instance.cancel_run(thread_id, run_id)
|
|
67
76
|
p result
|
|
68
77
|
rescue OpenApiOpenAIClient::ApiError => e
|
|
69
|
-
puts "Exception when calling
|
|
78
|
+
puts "Exception when calling AssistantsApi->cancel_run: #{e}"
|
|
70
79
|
end
|
|
71
80
|
|
|
72
81
|
```
|
|
@@ -77,45 +86,115 @@ All URIs are relative to *https://api.openai.com/v1*
|
|
|
77
86
|
|
|
78
87
|
Class | Method | HTTP request | Description
|
|
79
88
|
------------ | ------------- | ------------- | -------------
|
|
80
|
-
*OpenApiOpenAIClient::
|
|
81
|
-
*OpenApiOpenAIClient::
|
|
82
|
-
*OpenApiOpenAIClient::
|
|
83
|
-
*OpenApiOpenAIClient::
|
|
84
|
-
*OpenApiOpenAIClient::
|
|
85
|
-
*OpenApiOpenAIClient::
|
|
86
|
-
*OpenApiOpenAIClient::
|
|
87
|
-
*OpenApiOpenAIClient::
|
|
88
|
-
*OpenApiOpenAIClient::
|
|
89
|
-
*OpenApiOpenAIClient::
|
|
90
|
-
*OpenApiOpenAIClient::
|
|
91
|
-
*OpenApiOpenAIClient::
|
|
92
|
-
*OpenApiOpenAIClient::
|
|
93
|
-
*OpenApiOpenAIClient::
|
|
94
|
-
*OpenApiOpenAIClient::
|
|
95
|
-
*OpenApiOpenAIClient::
|
|
96
|
-
*OpenApiOpenAIClient::
|
|
97
|
-
*OpenApiOpenAIClient::
|
|
98
|
-
*OpenApiOpenAIClient::
|
|
99
|
-
*OpenApiOpenAIClient::
|
|
100
|
-
*OpenApiOpenAIClient::
|
|
101
|
-
*OpenApiOpenAIClient::
|
|
102
|
-
*OpenApiOpenAIClient::
|
|
89
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**cancel_run**](docs/AssistantsApi.md#cancel_run) | **POST** /threads/{thread_id}/runs/{run_id}/cancel | Cancels a run that is `in_progress`.
|
|
90
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**create_assistant**](docs/AssistantsApi.md#create_assistant) | **POST** /assistants | Create an assistant with a model and instructions.
|
|
91
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**create_assistant_file**](docs/AssistantsApi.md#create_assistant_file) | **POST** /assistants/{assistant_id}/files | Create an assistant file by attaching a [File](/docs/api-reference/files) to an [assistant](/docs/api-reference/assistants).
|
|
92
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**create_message**](docs/AssistantsApi.md#create_message) | **POST** /threads/{thread_id}/messages | Create a message.
|
|
93
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**create_run**](docs/AssistantsApi.md#create_run) | **POST** /threads/{thread_id}/runs | Create a run.
|
|
94
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**create_thread**](docs/AssistantsApi.md#create_thread) | **POST** /threads | Create a thread.
|
|
95
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**create_thread_and_run**](docs/AssistantsApi.md#create_thread_and_run) | **POST** /threads/runs | Create a thread and run it in one request.
|
|
96
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**delete_assistant**](docs/AssistantsApi.md#delete_assistant) | **DELETE** /assistants/{assistant_id} | Delete an assistant.
|
|
97
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**delete_assistant_file**](docs/AssistantsApi.md#delete_assistant_file) | **DELETE** /assistants/{assistant_id}/files/{file_id} | Delete an assistant file.
|
|
98
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**delete_thread**](docs/AssistantsApi.md#delete_thread) | **DELETE** /threads/{thread_id} | Delete a thread.
|
|
99
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**get_assistant**](docs/AssistantsApi.md#get_assistant) | **GET** /assistants/{assistant_id} | Retrieves an assistant.
|
|
100
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**get_assistant_file**](docs/AssistantsApi.md#get_assistant_file) | **GET** /assistants/{assistant_id}/files/{file_id} | Retrieves an AssistantFile.
|
|
101
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**get_message**](docs/AssistantsApi.md#get_message) | **GET** /threads/{thread_id}/messages/{message_id} | Retrieve a message.
|
|
102
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**get_message_file**](docs/AssistantsApi.md#get_message_file) | **GET** /threads/{thread_id}/messages/{message_id}/files/{file_id} | Retrieves a message file.
|
|
103
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**get_run**](docs/AssistantsApi.md#get_run) | **GET** /threads/{thread_id}/runs/{run_id} | Retrieves a run.
|
|
104
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**get_run_step**](docs/AssistantsApi.md#get_run_step) | **GET** /threads/{thread_id}/runs/{run_id}/steps/{step_id} | Retrieves a run step.
|
|
105
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**get_thread**](docs/AssistantsApi.md#get_thread) | **GET** /threads/{thread_id} | Retrieves a thread.
|
|
106
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**list_assistant_files**](docs/AssistantsApi.md#list_assistant_files) | **GET** /assistants/{assistant_id}/files | Returns a list of assistant files.
|
|
107
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**list_assistants**](docs/AssistantsApi.md#list_assistants) | **GET** /assistants | Returns a list of assistants.
|
|
108
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**list_message_files**](docs/AssistantsApi.md#list_message_files) | **GET** /threads/{thread_id}/messages/{message_id}/files | Returns a list of message files.
|
|
109
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**list_messages**](docs/AssistantsApi.md#list_messages) | **GET** /threads/{thread_id}/messages | Returns a list of messages for a given thread.
|
|
110
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**list_run_steps**](docs/AssistantsApi.md#list_run_steps) | **GET** /threads/{thread_id}/runs/{run_id}/steps | Returns a list of run steps belonging to a run.
|
|
111
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**list_runs**](docs/AssistantsApi.md#list_runs) | **GET** /threads/{thread_id}/runs | Returns a list of runs belonging to a thread.
|
|
112
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**modify_assistant**](docs/AssistantsApi.md#modify_assistant) | **POST** /assistants/{assistant_id} | Modifies an assistant.
|
|
113
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**modify_message**](docs/AssistantsApi.md#modify_message) | **POST** /threads/{thread_id}/messages/{message_id} | Modifies a message.
|
|
114
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**modify_run**](docs/AssistantsApi.md#modify_run) | **POST** /threads/{thread_id}/runs/{run_id} | Modifies a run.
|
|
115
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**modify_thread**](docs/AssistantsApi.md#modify_thread) | **POST** /threads/{thread_id} | Modifies a thread.
|
|
116
|
+
*OpenApiOpenAIClient::AssistantsApi* | [**submit_tool_ouputs_to_run**](docs/AssistantsApi.md#submit_tool_ouputs_to_run) | **POST** /threads/{thread_id}/runs/{run_id}/submit_tool_outputs | When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.
|
|
117
|
+
*OpenApiOpenAIClient::AudioApi* | [**create_speech**](docs/AudioApi.md#create_speech) | **POST** /audio/speech | Generates audio from the input text.
|
|
118
|
+
*OpenApiOpenAIClient::AudioApi* | [**create_transcription**](docs/AudioApi.md#create_transcription) | **POST** /audio/transcriptions | Transcribes audio into the input language.
|
|
119
|
+
*OpenApiOpenAIClient::AudioApi* | [**create_translation**](docs/AudioApi.md#create_translation) | **POST** /audio/translations | Translates audio into English.
|
|
120
|
+
*OpenApiOpenAIClient::ChatApi* | [**create_chat_completion**](docs/ChatApi.md#create_chat_completion) | **POST** /chat/completions | Creates a model response for the given chat conversation.
|
|
121
|
+
*OpenApiOpenAIClient::CompletionsApi* | [**create_completion**](docs/CompletionsApi.md#create_completion) | **POST** /completions | Creates a completion for the provided prompt and parameters.
|
|
122
|
+
*OpenApiOpenAIClient::EmbeddingsApi* | [**create_embedding**](docs/EmbeddingsApi.md#create_embedding) | **POST** /embeddings | Creates an embedding vector representing the input text.
|
|
123
|
+
*OpenApiOpenAIClient::FilesApi* | [**create_file**](docs/FilesApi.md#create_file) | **POST** /files | Upload a file that can be used across various endpoints. The size of all the files uploaded by one organization can be up to 100 GB. The size of individual files can be a maximum of 512 MB or 2 million tokens for Assistants. See the [Assistants Tools guide](/docs/assistants/tools) to learn more about the types of files supported. The Fine-tuning API only supports `.jsonl` files. Please [contact us](https://help.openai.com/) if you need to increase these storage limits.
|
|
124
|
+
*OpenApiOpenAIClient::FilesApi* | [**delete_file**](docs/FilesApi.md#delete_file) | **DELETE** /files/{file_id} | Delete a file.
|
|
125
|
+
*OpenApiOpenAIClient::FilesApi* | [**download_file**](docs/FilesApi.md#download_file) | **GET** /files/{file_id}/content | Returns the contents of the specified file.
|
|
126
|
+
*OpenApiOpenAIClient::FilesApi* | [**list_files**](docs/FilesApi.md#list_files) | **GET** /files | Returns a list of files that belong to the user's organization.
|
|
127
|
+
*OpenApiOpenAIClient::FilesApi* | [**retrieve_file**](docs/FilesApi.md#retrieve_file) | **GET** /files/{file_id} | Returns information about a specific file.
|
|
128
|
+
*OpenApiOpenAIClient::FineTuningApi* | [**cancel_fine_tuning_job**](docs/FineTuningApi.md#cancel_fine_tuning_job) | **POST** /fine_tuning/jobs/{fine_tuning_job_id}/cancel | Immediately cancel a fine-tune job.
|
|
129
|
+
*OpenApiOpenAIClient::FineTuningApi* | [**create_fine_tuning_job**](docs/FineTuningApi.md#create_fine_tuning_job) | **POST** /fine_tuning/jobs | 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)
|
|
130
|
+
*OpenApiOpenAIClient::FineTuningApi* | [**list_fine_tuning_events**](docs/FineTuningApi.md#list_fine_tuning_events) | **GET** /fine_tuning/jobs/{fine_tuning_job_id}/events | Get status updates for a fine-tuning job.
|
|
131
|
+
*OpenApiOpenAIClient::FineTuningApi* | [**list_fine_tuning_job_checkpoints**](docs/FineTuningApi.md#list_fine_tuning_job_checkpoints) | **GET** /fine_tuning/jobs/{fine_tuning_job_id}/checkpoints | List checkpoints for a fine-tuning job.
|
|
132
|
+
*OpenApiOpenAIClient::FineTuningApi* | [**list_paginated_fine_tuning_jobs**](docs/FineTuningApi.md#list_paginated_fine_tuning_jobs) | **GET** /fine_tuning/jobs | List your organization's fine-tuning jobs
|
|
133
|
+
*OpenApiOpenAIClient::FineTuningApi* | [**retrieve_fine_tuning_job**](docs/FineTuningApi.md#retrieve_fine_tuning_job) | **GET** /fine_tuning/jobs/{fine_tuning_job_id} | Get info about a fine-tuning job. [Learn more about fine-tuning](/docs/guides/fine-tuning)
|
|
134
|
+
*OpenApiOpenAIClient::ImagesApi* | [**create_image**](docs/ImagesApi.md#create_image) | **POST** /images/generations | Creates an image given a prompt.
|
|
135
|
+
*OpenApiOpenAIClient::ImagesApi* | [**create_image_edit**](docs/ImagesApi.md#create_image_edit) | **POST** /images/edits | Creates an edited or extended image given an original image and a prompt.
|
|
136
|
+
*OpenApiOpenAIClient::ImagesApi* | [**create_image_variation**](docs/ImagesApi.md#create_image_variation) | **POST** /images/variations | Creates a variation of a given image.
|
|
137
|
+
*OpenApiOpenAIClient::ModelsApi* | [**delete_model**](docs/ModelsApi.md#delete_model) | **DELETE** /models/{model} | Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.
|
|
138
|
+
*OpenApiOpenAIClient::ModelsApi* | [**list_models**](docs/ModelsApi.md#list_models) | **GET** /models | Lists the currently available models, and provides basic information about each one such as the owner and availability.
|
|
139
|
+
*OpenApiOpenAIClient::ModelsApi* | [**retrieve_model**](docs/ModelsApi.md#retrieve_model) | **GET** /models/{model} | Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
|
|
140
|
+
*OpenApiOpenAIClient::ModerationsApi* | [**create_moderation**](docs/ModerationsApi.md#create_moderation) | **POST** /moderations | Classifies if text is potentially harmful.
|
|
103
141
|
|
|
104
142
|
|
|
105
143
|
## Documentation for Models
|
|
106
144
|
|
|
145
|
+
- [OpenApiOpenAIClient::AssistantFileObject](docs/AssistantFileObject.md)
|
|
146
|
+
- [OpenApiOpenAIClient::AssistantObject](docs/AssistantObject.md)
|
|
147
|
+
- [OpenApiOpenAIClient::AssistantObjectToolsInner](docs/AssistantObjectToolsInner.md)
|
|
148
|
+
- [OpenApiOpenAIClient::AssistantStreamEvent](docs/AssistantStreamEvent.md)
|
|
149
|
+
- [OpenApiOpenAIClient::AssistantToolsCode](docs/AssistantToolsCode.md)
|
|
150
|
+
- [OpenApiOpenAIClient::AssistantToolsFunction](docs/AssistantToolsFunction.md)
|
|
151
|
+
- [OpenApiOpenAIClient::AssistantToolsRetrieval](docs/AssistantToolsRetrieval.md)
|
|
152
|
+
- [OpenApiOpenAIClient::AssistantsApiNamedToolChoice](docs/AssistantsApiNamedToolChoice.md)
|
|
153
|
+
- [OpenApiOpenAIClient::AssistantsApiResponseFormat](docs/AssistantsApiResponseFormat.md)
|
|
154
|
+
- [OpenApiOpenAIClient::AssistantsApiResponseFormatOption](docs/AssistantsApiResponseFormatOption.md)
|
|
155
|
+
- [OpenApiOpenAIClient::AssistantsApiToolChoiceOption](docs/AssistantsApiToolChoiceOption.md)
|
|
156
|
+
- [OpenApiOpenAIClient::ChatCompletionFunctionCallOption](docs/ChatCompletionFunctionCallOption.md)
|
|
107
157
|
- [OpenApiOpenAIClient::ChatCompletionFunctions](docs/ChatCompletionFunctions.md)
|
|
158
|
+
- [OpenApiOpenAIClient::ChatCompletionMessageToolCall](docs/ChatCompletionMessageToolCall.md)
|
|
159
|
+
- [OpenApiOpenAIClient::ChatCompletionMessageToolCallChunk](docs/ChatCompletionMessageToolCallChunk.md)
|
|
160
|
+
- [OpenApiOpenAIClient::ChatCompletionMessageToolCallChunkFunction](docs/ChatCompletionMessageToolCallChunkFunction.md)
|
|
161
|
+
- [OpenApiOpenAIClient::ChatCompletionMessageToolCallFunction](docs/ChatCompletionMessageToolCallFunction.md)
|
|
162
|
+
- [OpenApiOpenAIClient::ChatCompletionNamedToolChoice](docs/ChatCompletionNamedToolChoice.md)
|
|
163
|
+
- [OpenApiOpenAIClient::ChatCompletionNamedToolChoiceFunction](docs/ChatCompletionNamedToolChoiceFunction.md)
|
|
164
|
+
- [OpenApiOpenAIClient::ChatCompletionRequestAssistantMessage](docs/ChatCompletionRequestAssistantMessage.md)
|
|
165
|
+
- [OpenApiOpenAIClient::ChatCompletionRequestAssistantMessageFunctionCall](docs/ChatCompletionRequestAssistantMessageFunctionCall.md)
|
|
166
|
+
- [OpenApiOpenAIClient::ChatCompletionRequestFunctionMessage](docs/ChatCompletionRequestFunctionMessage.md)
|
|
108
167
|
- [OpenApiOpenAIClient::ChatCompletionRequestMessage](docs/ChatCompletionRequestMessage.md)
|
|
109
|
-
- [OpenApiOpenAIClient::
|
|
168
|
+
- [OpenApiOpenAIClient::ChatCompletionRequestMessageContentPart](docs/ChatCompletionRequestMessageContentPart.md)
|
|
169
|
+
- [OpenApiOpenAIClient::ChatCompletionRequestMessageContentPartImage](docs/ChatCompletionRequestMessageContentPartImage.md)
|
|
170
|
+
- [OpenApiOpenAIClient::ChatCompletionRequestMessageContentPartImageImageUrl](docs/ChatCompletionRequestMessageContentPartImageImageUrl.md)
|
|
171
|
+
- [OpenApiOpenAIClient::ChatCompletionRequestMessageContentPartText](docs/ChatCompletionRequestMessageContentPartText.md)
|
|
172
|
+
- [OpenApiOpenAIClient::ChatCompletionRequestSystemMessage](docs/ChatCompletionRequestSystemMessage.md)
|
|
173
|
+
- [OpenApiOpenAIClient::ChatCompletionRequestToolMessage](docs/ChatCompletionRequestToolMessage.md)
|
|
174
|
+
- [OpenApiOpenAIClient::ChatCompletionRequestUserMessage](docs/ChatCompletionRequestUserMessage.md)
|
|
175
|
+
- [OpenApiOpenAIClient::ChatCompletionRequestUserMessageContent](docs/ChatCompletionRequestUserMessageContent.md)
|
|
110
176
|
- [OpenApiOpenAIClient::ChatCompletionResponseMessage](docs/ChatCompletionResponseMessage.md)
|
|
177
|
+
- [OpenApiOpenAIClient::ChatCompletionRole](docs/ChatCompletionRole.md)
|
|
111
178
|
- [OpenApiOpenAIClient::ChatCompletionStreamResponseDelta](docs/ChatCompletionStreamResponseDelta.md)
|
|
179
|
+
- [OpenApiOpenAIClient::ChatCompletionStreamResponseDeltaFunctionCall](docs/ChatCompletionStreamResponseDeltaFunctionCall.md)
|
|
180
|
+
- [OpenApiOpenAIClient::ChatCompletionTokenLogprob](docs/ChatCompletionTokenLogprob.md)
|
|
181
|
+
- [OpenApiOpenAIClient::ChatCompletionTokenLogprobTopLogprobsInner](docs/ChatCompletionTokenLogprobTopLogprobsInner.md)
|
|
182
|
+
- [OpenApiOpenAIClient::ChatCompletionTool](docs/ChatCompletionTool.md)
|
|
183
|
+
- [OpenApiOpenAIClient::ChatCompletionToolChoiceOption](docs/ChatCompletionToolChoiceOption.md)
|
|
184
|
+
- [OpenApiOpenAIClient::CompletionUsage](docs/CompletionUsage.md)
|
|
185
|
+
- [OpenApiOpenAIClient::CreateAssistantFileRequest](docs/CreateAssistantFileRequest.md)
|
|
186
|
+
- [OpenApiOpenAIClient::CreateAssistantRequest](docs/CreateAssistantRequest.md)
|
|
187
|
+
- [OpenApiOpenAIClient::CreateAssistantRequestModel](docs/CreateAssistantRequestModel.md)
|
|
188
|
+
- [OpenApiOpenAIClient::CreateChatCompletionFunctionResponse](docs/CreateChatCompletionFunctionResponse.md)
|
|
189
|
+
- [OpenApiOpenAIClient::CreateChatCompletionFunctionResponseChoicesInner](docs/CreateChatCompletionFunctionResponseChoicesInner.md)
|
|
112
190
|
- [OpenApiOpenAIClient::CreateChatCompletionRequest](docs/CreateChatCompletionRequest.md)
|
|
113
191
|
- [OpenApiOpenAIClient::CreateChatCompletionRequestFunctionCall](docs/CreateChatCompletionRequestFunctionCall.md)
|
|
114
|
-
- [OpenApiOpenAIClient::CreateChatCompletionRequestFunctionCallOneOf](docs/CreateChatCompletionRequestFunctionCallOneOf.md)
|
|
115
192
|
- [OpenApiOpenAIClient::CreateChatCompletionRequestModel](docs/CreateChatCompletionRequestModel.md)
|
|
193
|
+
- [OpenApiOpenAIClient::CreateChatCompletionRequestResponseFormat](docs/CreateChatCompletionRequestResponseFormat.md)
|
|
116
194
|
- [OpenApiOpenAIClient::CreateChatCompletionRequestStop](docs/CreateChatCompletionRequestStop.md)
|
|
117
195
|
- [OpenApiOpenAIClient::CreateChatCompletionResponse](docs/CreateChatCompletionResponse.md)
|
|
118
196
|
- [OpenApiOpenAIClient::CreateChatCompletionResponseChoicesInner](docs/CreateChatCompletionResponseChoicesInner.md)
|
|
197
|
+
- [OpenApiOpenAIClient::CreateChatCompletionResponseChoicesInnerLogprobs](docs/CreateChatCompletionResponseChoicesInnerLogprobs.md)
|
|
119
198
|
- [OpenApiOpenAIClient::CreateChatCompletionStreamResponse](docs/CreateChatCompletionStreamResponse.md)
|
|
120
199
|
- [OpenApiOpenAIClient::CreateChatCompletionStreamResponseChoicesInner](docs/CreateChatCompletionStreamResponseChoicesInner.md)
|
|
121
200
|
- [OpenApiOpenAIClient::CreateCompletionRequest](docs/CreateCompletionRequest.md)
|
|
@@ -125,20 +204,24 @@ Class | Method | HTTP request | Description
|
|
|
125
204
|
- [OpenApiOpenAIClient::CreateCompletionResponse](docs/CreateCompletionResponse.md)
|
|
126
205
|
- [OpenApiOpenAIClient::CreateCompletionResponseChoicesInner](docs/CreateCompletionResponseChoicesInner.md)
|
|
127
206
|
- [OpenApiOpenAIClient::CreateCompletionResponseChoicesInnerLogprobs](docs/CreateCompletionResponseChoicesInnerLogprobs.md)
|
|
128
|
-
- [OpenApiOpenAIClient::CreateCompletionResponseUsage](docs/CreateCompletionResponseUsage.md)
|
|
129
|
-
- [OpenApiOpenAIClient::CreateEditRequest](docs/CreateEditRequest.md)
|
|
130
|
-
- [OpenApiOpenAIClient::CreateEditRequestModel](docs/CreateEditRequestModel.md)
|
|
131
|
-
- [OpenApiOpenAIClient::CreateEditResponse](docs/CreateEditResponse.md)
|
|
132
|
-
- [OpenApiOpenAIClient::CreateEditResponseChoicesInner](docs/CreateEditResponseChoicesInner.md)
|
|
133
207
|
- [OpenApiOpenAIClient::CreateEmbeddingRequest](docs/CreateEmbeddingRequest.md)
|
|
134
208
|
- [OpenApiOpenAIClient::CreateEmbeddingRequestInput](docs/CreateEmbeddingRequestInput.md)
|
|
135
209
|
- [OpenApiOpenAIClient::CreateEmbeddingRequestModel](docs/CreateEmbeddingRequestModel.md)
|
|
136
210
|
- [OpenApiOpenAIClient::CreateEmbeddingResponse](docs/CreateEmbeddingResponse.md)
|
|
137
|
-
- [OpenApiOpenAIClient::CreateEmbeddingResponseDataInner](docs/CreateEmbeddingResponseDataInner.md)
|
|
138
211
|
- [OpenApiOpenAIClient::CreateEmbeddingResponseUsage](docs/CreateEmbeddingResponseUsage.md)
|
|
139
|
-
- [OpenApiOpenAIClient::
|
|
140
|
-
- [OpenApiOpenAIClient::
|
|
212
|
+
- [OpenApiOpenAIClient::CreateFineTuningJobRequest](docs/CreateFineTuningJobRequest.md)
|
|
213
|
+
- [OpenApiOpenAIClient::CreateFineTuningJobRequestHyperparameters](docs/CreateFineTuningJobRequestHyperparameters.md)
|
|
214
|
+
- [OpenApiOpenAIClient::CreateFineTuningJobRequestHyperparametersBatchSize](docs/CreateFineTuningJobRequestHyperparametersBatchSize.md)
|
|
215
|
+
- [OpenApiOpenAIClient::CreateFineTuningJobRequestHyperparametersLearningRateMultiplier](docs/CreateFineTuningJobRequestHyperparametersLearningRateMultiplier.md)
|
|
216
|
+
- [OpenApiOpenAIClient::CreateFineTuningJobRequestHyperparametersNEpochs](docs/CreateFineTuningJobRequestHyperparametersNEpochs.md)
|
|
217
|
+
- [OpenApiOpenAIClient::CreateFineTuningJobRequestIntegrationsInner](docs/CreateFineTuningJobRequestIntegrationsInner.md)
|
|
218
|
+
- [OpenApiOpenAIClient::CreateFineTuningJobRequestIntegrationsInnerType](docs/CreateFineTuningJobRequestIntegrationsInnerType.md)
|
|
219
|
+
- [OpenApiOpenAIClient::CreateFineTuningJobRequestIntegrationsInnerWandb](docs/CreateFineTuningJobRequestIntegrationsInnerWandb.md)
|
|
220
|
+
- [OpenApiOpenAIClient::CreateFineTuningJobRequestModel](docs/CreateFineTuningJobRequestModel.md)
|
|
221
|
+
- [OpenApiOpenAIClient::CreateImageEditRequestModel](docs/CreateImageEditRequestModel.md)
|
|
141
222
|
- [OpenApiOpenAIClient::CreateImageRequest](docs/CreateImageRequest.md)
|
|
223
|
+
- [OpenApiOpenAIClient::CreateImageRequestModel](docs/CreateImageRequestModel.md)
|
|
224
|
+
- [OpenApiOpenAIClient::CreateMessageRequest](docs/CreateMessageRequest.md)
|
|
142
225
|
- [OpenApiOpenAIClient::CreateModerationRequest](docs/CreateModerationRequest.md)
|
|
143
226
|
- [OpenApiOpenAIClient::CreateModerationRequestInput](docs/CreateModerationRequestInput.md)
|
|
144
227
|
- [OpenApiOpenAIClient::CreateModerationRequestModel](docs/CreateModerationRequestModel.md)
|
|
@@ -146,26 +229,166 @@ Class | Method | HTTP request | Description
|
|
|
146
229
|
- [OpenApiOpenAIClient::CreateModerationResponseResultsInner](docs/CreateModerationResponseResultsInner.md)
|
|
147
230
|
- [OpenApiOpenAIClient::CreateModerationResponseResultsInnerCategories](docs/CreateModerationResponseResultsInnerCategories.md)
|
|
148
231
|
- [OpenApiOpenAIClient::CreateModerationResponseResultsInnerCategoryScores](docs/CreateModerationResponseResultsInnerCategoryScores.md)
|
|
232
|
+
- [OpenApiOpenAIClient::CreateRunRequest](docs/CreateRunRequest.md)
|
|
233
|
+
- [OpenApiOpenAIClient::CreateRunRequestModel](docs/CreateRunRequestModel.md)
|
|
234
|
+
- [OpenApiOpenAIClient::CreateSpeechRequest](docs/CreateSpeechRequest.md)
|
|
235
|
+
- [OpenApiOpenAIClient::CreateSpeechRequestModel](docs/CreateSpeechRequestModel.md)
|
|
236
|
+
- [OpenApiOpenAIClient::CreateThreadAndRunRequest](docs/CreateThreadAndRunRequest.md)
|
|
237
|
+
- [OpenApiOpenAIClient::CreateThreadAndRunRequestToolsInner](docs/CreateThreadAndRunRequestToolsInner.md)
|
|
238
|
+
- [OpenApiOpenAIClient::CreateThreadRequest](docs/CreateThreadRequest.md)
|
|
239
|
+
- [OpenApiOpenAIClient::CreateTranscription200Response](docs/CreateTranscription200Response.md)
|
|
149
240
|
- [OpenApiOpenAIClient::CreateTranscriptionRequestModel](docs/CreateTranscriptionRequestModel.md)
|
|
150
|
-
- [OpenApiOpenAIClient::
|
|
151
|
-
- [OpenApiOpenAIClient::
|
|
241
|
+
- [OpenApiOpenAIClient::CreateTranscriptionResponseJson](docs/CreateTranscriptionResponseJson.md)
|
|
242
|
+
- [OpenApiOpenAIClient::CreateTranscriptionResponseVerboseJson](docs/CreateTranscriptionResponseVerboseJson.md)
|
|
243
|
+
- [OpenApiOpenAIClient::CreateTranslation200Response](docs/CreateTranslation200Response.md)
|
|
244
|
+
- [OpenApiOpenAIClient::CreateTranslationResponseJson](docs/CreateTranslationResponseJson.md)
|
|
245
|
+
- [OpenApiOpenAIClient::CreateTranslationResponseVerboseJson](docs/CreateTranslationResponseVerboseJson.md)
|
|
246
|
+
- [OpenApiOpenAIClient::DeleteAssistantFileResponse](docs/DeleteAssistantFileResponse.md)
|
|
247
|
+
- [OpenApiOpenAIClient::DeleteAssistantResponse](docs/DeleteAssistantResponse.md)
|
|
152
248
|
- [OpenApiOpenAIClient::DeleteFileResponse](docs/DeleteFileResponse.md)
|
|
249
|
+
- [OpenApiOpenAIClient::DeleteMessageResponse](docs/DeleteMessageResponse.md)
|
|
153
250
|
- [OpenApiOpenAIClient::DeleteModelResponse](docs/DeleteModelResponse.md)
|
|
251
|
+
- [OpenApiOpenAIClient::DeleteThreadResponse](docs/DeleteThreadResponse.md)
|
|
252
|
+
- [OpenApiOpenAIClient::DoneEvent](docs/DoneEvent.md)
|
|
253
|
+
- [OpenApiOpenAIClient::Embedding](docs/Embedding.md)
|
|
154
254
|
- [OpenApiOpenAIClient::Error](docs/Error.md)
|
|
255
|
+
- [OpenApiOpenAIClient::ErrorEvent](docs/ErrorEvent.md)
|
|
155
256
|
- [OpenApiOpenAIClient::ErrorResponse](docs/ErrorResponse.md)
|
|
156
|
-
- [OpenApiOpenAIClient::
|
|
157
|
-
- [OpenApiOpenAIClient::
|
|
257
|
+
- [OpenApiOpenAIClient::FineTuningIntegration](docs/FineTuningIntegration.md)
|
|
258
|
+
- [OpenApiOpenAIClient::FineTuningJob](docs/FineTuningJob.md)
|
|
259
|
+
- [OpenApiOpenAIClient::FineTuningJobCheckpoint](docs/FineTuningJobCheckpoint.md)
|
|
260
|
+
- [OpenApiOpenAIClient::FineTuningJobCheckpointMetrics](docs/FineTuningJobCheckpointMetrics.md)
|
|
261
|
+
- [OpenApiOpenAIClient::FineTuningJobError](docs/FineTuningJobError.md)
|
|
262
|
+
- [OpenApiOpenAIClient::FineTuningJobEvent](docs/FineTuningJobEvent.md)
|
|
263
|
+
- [OpenApiOpenAIClient::FineTuningJobHyperparameters](docs/FineTuningJobHyperparameters.md)
|
|
264
|
+
- [OpenApiOpenAIClient::FineTuningJobHyperparametersNEpochs](docs/FineTuningJobHyperparametersNEpochs.md)
|
|
265
|
+
- [OpenApiOpenAIClient::FineTuningJobIntegrationsInner](docs/FineTuningJobIntegrationsInner.md)
|
|
266
|
+
- [OpenApiOpenAIClient::FunctionObject](docs/FunctionObject.md)
|
|
267
|
+
- [OpenApiOpenAIClient::Image](docs/Image.md)
|
|
158
268
|
- [OpenApiOpenAIClient::ImagesResponse](docs/ImagesResponse.md)
|
|
159
|
-
- [OpenApiOpenAIClient::
|
|
269
|
+
- [OpenApiOpenAIClient::ListAssistantFilesResponse](docs/ListAssistantFilesResponse.md)
|
|
270
|
+
- [OpenApiOpenAIClient::ListAssistantsResponse](docs/ListAssistantsResponse.md)
|
|
160
271
|
- [OpenApiOpenAIClient::ListFilesResponse](docs/ListFilesResponse.md)
|
|
161
|
-
- [OpenApiOpenAIClient::
|
|
162
|
-
- [OpenApiOpenAIClient::
|
|
272
|
+
- [OpenApiOpenAIClient::ListFineTuningJobCheckpointsResponse](docs/ListFineTuningJobCheckpointsResponse.md)
|
|
273
|
+
- [OpenApiOpenAIClient::ListFineTuningJobEventsResponse](docs/ListFineTuningJobEventsResponse.md)
|
|
274
|
+
- [OpenApiOpenAIClient::ListMessageFilesResponse](docs/ListMessageFilesResponse.md)
|
|
275
|
+
- [OpenApiOpenAIClient::ListMessagesResponse](docs/ListMessagesResponse.md)
|
|
163
276
|
- [OpenApiOpenAIClient::ListModelsResponse](docs/ListModelsResponse.md)
|
|
277
|
+
- [OpenApiOpenAIClient::ListPaginatedFineTuningJobsResponse](docs/ListPaginatedFineTuningJobsResponse.md)
|
|
278
|
+
- [OpenApiOpenAIClient::ListRunStepsResponse](docs/ListRunStepsResponse.md)
|
|
279
|
+
- [OpenApiOpenAIClient::ListRunsResponse](docs/ListRunsResponse.md)
|
|
280
|
+
- [OpenApiOpenAIClient::ListThreadsResponse](docs/ListThreadsResponse.md)
|
|
281
|
+
- [OpenApiOpenAIClient::MessageContentImageFileObject](docs/MessageContentImageFileObject.md)
|
|
282
|
+
- [OpenApiOpenAIClient::MessageContentImageFileObjectImageFile](docs/MessageContentImageFileObjectImageFile.md)
|
|
283
|
+
- [OpenApiOpenAIClient::MessageContentTextAnnotationsFileCitationObject](docs/MessageContentTextAnnotationsFileCitationObject.md)
|
|
284
|
+
- [OpenApiOpenAIClient::MessageContentTextAnnotationsFileCitationObjectFileCitation](docs/MessageContentTextAnnotationsFileCitationObjectFileCitation.md)
|
|
285
|
+
- [OpenApiOpenAIClient::MessageContentTextAnnotationsFilePathObject](docs/MessageContentTextAnnotationsFilePathObject.md)
|
|
286
|
+
- [OpenApiOpenAIClient::MessageContentTextAnnotationsFilePathObjectFilePath](docs/MessageContentTextAnnotationsFilePathObjectFilePath.md)
|
|
287
|
+
- [OpenApiOpenAIClient::MessageContentTextObject](docs/MessageContentTextObject.md)
|
|
288
|
+
- [OpenApiOpenAIClient::MessageContentTextObjectText](docs/MessageContentTextObjectText.md)
|
|
289
|
+
- [OpenApiOpenAIClient::MessageContentTextObjectTextAnnotationsInner](docs/MessageContentTextObjectTextAnnotationsInner.md)
|
|
290
|
+
- [OpenApiOpenAIClient::MessageDeltaContentImageFileObject](docs/MessageDeltaContentImageFileObject.md)
|
|
291
|
+
- [OpenApiOpenAIClient::MessageDeltaContentImageFileObjectImageFile](docs/MessageDeltaContentImageFileObjectImageFile.md)
|
|
292
|
+
- [OpenApiOpenAIClient::MessageDeltaContentTextAnnotationsFileCitationObject](docs/MessageDeltaContentTextAnnotationsFileCitationObject.md)
|
|
293
|
+
- [OpenApiOpenAIClient::MessageDeltaContentTextAnnotationsFileCitationObjectFileCitation](docs/MessageDeltaContentTextAnnotationsFileCitationObjectFileCitation.md)
|
|
294
|
+
- [OpenApiOpenAIClient::MessageDeltaContentTextAnnotationsFilePathObject](docs/MessageDeltaContentTextAnnotationsFilePathObject.md)
|
|
295
|
+
- [OpenApiOpenAIClient::MessageDeltaContentTextAnnotationsFilePathObjectFilePath](docs/MessageDeltaContentTextAnnotationsFilePathObjectFilePath.md)
|
|
296
|
+
- [OpenApiOpenAIClient::MessageDeltaContentTextObject](docs/MessageDeltaContentTextObject.md)
|
|
297
|
+
- [OpenApiOpenAIClient::MessageDeltaContentTextObjectText](docs/MessageDeltaContentTextObjectText.md)
|
|
298
|
+
- [OpenApiOpenAIClient::MessageDeltaContentTextObjectTextAnnotationsInner](docs/MessageDeltaContentTextObjectTextAnnotationsInner.md)
|
|
299
|
+
- [OpenApiOpenAIClient::MessageDeltaObject](docs/MessageDeltaObject.md)
|
|
300
|
+
- [OpenApiOpenAIClient::MessageDeltaObjectDelta](docs/MessageDeltaObjectDelta.md)
|
|
301
|
+
- [OpenApiOpenAIClient::MessageDeltaObjectDeltaContentInner](docs/MessageDeltaObjectDeltaContentInner.md)
|
|
302
|
+
- [OpenApiOpenAIClient::MessageFileObject](docs/MessageFileObject.md)
|
|
303
|
+
- [OpenApiOpenAIClient::MessageObject](docs/MessageObject.md)
|
|
304
|
+
- [OpenApiOpenAIClient::MessageObjectContentInner](docs/MessageObjectContentInner.md)
|
|
305
|
+
- [OpenApiOpenAIClient::MessageObjectIncompleteDetails](docs/MessageObjectIncompleteDetails.md)
|
|
306
|
+
- [OpenApiOpenAIClient::MessageStreamEvent](docs/MessageStreamEvent.md)
|
|
307
|
+
- [OpenApiOpenAIClient::MessageStreamEventOneOf](docs/MessageStreamEventOneOf.md)
|
|
308
|
+
- [OpenApiOpenAIClient::MessageStreamEventOneOf1](docs/MessageStreamEventOneOf1.md)
|
|
309
|
+
- [OpenApiOpenAIClient::MessageStreamEventOneOf2](docs/MessageStreamEventOneOf2.md)
|
|
310
|
+
- [OpenApiOpenAIClient::MessageStreamEventOneOf3](docs/MessageStreamEventOneOf3.md)
|
|
311
|
+
- [OpenApiOpenAIClient::MessageStreamEventOneOf4](docs/MessageStreamEventOneOf4.md)
|
|
164
312
|
- [OpenApiOpenAIClient::Model](docs/Model.md)
|
|
313
|
+
- [OpenApiOpenAIClient::ModifyAssistantRequest](docs/ModifyAssistantRequest.md)
|
|
314
|
+
- [OpenApiOpenAIClient::ModifyMessageRequest](docs/ModifyMessageRequest.md)
|
|
315
|
+
- [OpenApiOpenAIClient::ModifyRunRequest](docs/ModifyRunRequest.md)
|
|
316
|
+
- [OpenApiOpenAIClient::ModifyThreadRequest](docs/ModifyThreadRequest.md)
|
|
165
317
|
- [OpenApiOpenAIClient::OpenAIFile](docs/OpenAIFile.md)
|
|
318
|
+
- [OpenApiOpenAIClient::RunCompletionUsage](docs/RunCompletionUsage.md)
|
|
319
|
+
- [OpenApiOpenAIClient::RunObject](docs/RunObject.md)
|
|
320
|
+
- [OpenApiOpenAIClient::RunObjectIncompleteDetails](docs/RunObjectIncompleteDetails.md)
|
|
321
|
+
- [OpenApiOpenAIClient::RunObjectLastError](docs/RunObjectLastError.md)
|
|
322
|
+
- [OpenApiOpenAIClient::RunObjectRequiredAction](docs/RunObjectRequiredAction.md)
|
|
323
|
+
- [OpenApiOpenAIClient::RunObjectRequiredActionSubmitToolOutputs](docs/RunObjectRequiredActionSubmitToolOutputs.md)
|
|
324
|
+
- [OpenApiOpenAIClient::RunStepCompletionUsage](docs/RunStepCompletionUsage.md)
|
|
325
|
+
- [OpenApiOpenAIClient::RunStepDeltaObject](docs/RunStepDeltaObject.md)
|
|
326
|
+
- [OpenApiOpenAIClient::RunStepDeltaObjectDelta](docs/RunStepDeltaObjectDelta.md)
|
|
327
|
+
- [OpenApiOpenAIClient::RunStepDeltaObjectDeltaStepDetails](docs/RunStepDeltaObjectDeltaStepDetails.md)
|
|
328
|
+
- [OpenApiOpenAIClient::RunStepDeltaStepDetailsMessageCreationObject](docs/RunStepDeltaStepDetailsMessageCreationObject.md)
|
|
329
|
+
- [OpenApiOpenAIClient::RunStepDeltaStepDetailsMessageCreationObjectMessageCreation](docs/RunStepDeltaStepDetailsMessageCreationObjectMessageCreation.md)
|
|
330
|
+
- [OpenApiOpenAIClient::RunStepDeltaStepDetailsToolCallsCodeObject](docs/RunStepDeltaStepDetailsToolCallsCodeObject.md)
|
|
331
|
+
- [OpenApiOpenAIClient::RunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreter](docs/RunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreter.md)
|
|
332
|
+
- [OpenApiOpenAIClient::RunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreterOutputsInner](docs/RunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreterOutputsInner.md)
|
|
333
|
+
- [OpenApiOpenAIClient::RunStepDeltaStepDetailsToolCallsCodeOutputImageObject](docs/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject.md)
|
|
334
|
+
- [OpenApiOpenAIClient::RunStepDeltaStepDetailsToolCallsCodeOutputImageObjectImage](docs/RunStepDeltaStepDetailsToolCallsCodeOutputImageObjectImage.md)
|
|
335
|
+
- [OpenApiOpenAIClient::RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject](docs/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject.md)
|
|
336
|
+
- [OpenApiOpenAIClient::RunStepDeltaStepDetailsToolCallsFunctionObject](docs/RunStepDeltaStepDetailsToolCallsFunctionObject.md)
|
|
337
|
+
- [OpenApiOpenAIClient::RunStepDeltaStepDetailsToolCallsFunctionObjectFunction](docs/RunStepDeltaStepDetailsToolCallsFunctionObjectFunction.md)
|
|
338
|
+
- [OpenApiOpenAIClient::RunStepDeltaStepDetailsToolCallsObject](docs/RunStepDeltaStepDetailsToolCallsObject.md)
|
|
339
|
+
- [OpenApiOpenAIClient::RunStepDeltaStepDetailsToolCallsObjectToolCallsInner](docs/RunStepDeltaStepDetailsToolCallsObjectToolCallsInner.md)
|
|
340
|
+
- [OpenApiOpenAIClient::RunStepDeltaStepDetailsToolCallsRetrievalObject](docs/RunStepDeltaStepDetailsToolCallsRetrievalObject.md)
|
|
341
|
+
- [OpenApiOpenAIClient::RunStepDetailsMessageCreationObject](docs/RunStepDetailsMessageCreationObject.md)
|
|
342
|
+
- [OpenApiOpenAIClient::RunStepDetailsMessageCreationObjectMessageCreation](docs/RunStepDetailsMessageCreationObjectMessageCreation.md)
|
|
343
|
+
- [OpenApiOpenAIClient::RunStepDetailsToolCallsCodeObject](docs/RunStepDetailsToolCallsCodeObject.md)
|
|
344
|
+
- [OpenApiOpenAIClient::RunStepDetailsToolCallsCodeObjectCodeInterpreter](docs/RunStepDetailsToolCallsCodeObjectCodeInterpreter.md)
|
|
345
|
+
- [OpenApiOpenAIClient::RunStepDetailsToolCallsCodeObjectCodeInterpreterOutputsInner](docs/RunStepDetailsToolCallsCodeObjectCodeInterpreterOutputsInner.md)
|
|
346
|
+
- [OpenApiOpenAIClient::RunStepDetailsToolCallsCodeOutputImageObject](docs/RunStepDetailsToolCallsCodeOutputImageObject.md)
|
|
347
|
+
- [OpenApiOpenAIClient::RunStepDetailsToolCallsCodeOutputImageObjectImage](docs/RunStepDetailsToolCallsCodeOutputImageObjectImage.md)
|
|
348
|
+
- [OpenApiOpenAIClient::RunStepDetailsToolCallsCodeOutputLogsObject](docs/RunStepDetailsToolCallsCodeOutputLogsObject.md)
|
|
349
|
+
- [OpenApiOpenAIClient::RunStepDetailsToolCallsFunctionObject](docs/RunStepDetailsToolCallsFunctionObject.md)
|
|
350
|
+
- [OpenApiOpenAIClient::RunStepDetailsToolCallsFunctionObjectFunction](docs/RunStepDetailsToolCallsFunctionObjectFunction.md)
|
|
351
|
+
- [OpenApiOpenAIClient::RunStepDetailsToolCallsObject](docs/RunStepDetailsToolCallsObject.md)
|
|
352
|
+
- [OpenApiOpenAIClient::RunStepDetailsToolCallsObjectToolCallsInner](docs/RunStepDetailsToolCallsObjectToolCallsInner.md)
|
|
353
|
+
- [OpenApiOpenAIClient::RunStepDetailsToolCallsRetrievalObject](docs/RunStepDetailsToolCallsRetrievalObject.md)
|
|
354
|
+
- [OpenApiOpenAIClient::RunStepObject](docs/RunStepObject.md)
|
|
355
|
+
- [OpenApiOpenAIClient::RunStepObjectLastError](docs/RunStepObjectLastError.md)
|
|
356
|
+
- [OpenApiOpenAIClient::RunStepObjectStepDetails](docs/RunStepObjectStepDetails.md)
|
|
357
|
+
- [OpenApiOpenAIClient::RunStepStreamEvent](docs/RunStepStreamEvent.md)
|
|
358
|
+
- [OpenApiOpenAIClient::RunStepStreamEventOneOf](docs/RunStepStreamEventOneOf.md)
|
|
359
|
+
- [OpenApiOpenAIClient::RunStepStreamEventOneOf1](docs/RunStepStreamEventOneOf1.md)
|
|
360
|
+
- [OpenApiOpenAIClient::RunStepStreamEventOneOf2](docs/RunStepStreamEventOneOf2.md)
|
|
361
|
+
- [OpenApiOpenAIClient::RunStepStreamEventOneOf3](docs/RunStepStreamEventOneOf3.md)
|
|
362
|
+
- [OpenApiOpenAIClient::RunStepStreamEventOneOf4](docs/RunStepStreamEventOneOf4.md)
|
|
363
|
+
- [OpenApiOpenAIClient::RunStepStreamEventOneOf5](docs/RunStepStreamEventOneOf5.md)
|
|
364
|
+
- [OpenApiOpenAIClient::RunStepStreamEventOneOf6](docs/RunStepStreamEventOneOf6.md)
|
|
365
|
+
- [OpenApiOpenAIClient::RunStreamEvent](docs/RunStreamEvent.md)
|
|
366
|
+
- [OpenApiOpenAIClient::RunStreamEventOneOf](docs/RunStreamEventOneOf.md)
|
|
367
|
+
- [OpenApiOpenAIClient::RunStreamEventOneOf1](docs/RunStreamEventOneOf1.md)
|
|
368
|
+
- [OpenApiOpenAIClient::RunStreamEventOneOf2](docs/RunStreamEventOneOf2.md)
|
|
369
|
+
- [OpenApiOpenAIClient::RunStreamEventOneOf3](docs/RunStreamEventOneOf3.md)
|
|
370
|
+
- [OpenApiOpenAIClient::RunStreamEventOneOf4](docs/RunStreamEventOneOf4.md)
|
|
371
|
+
- [OpenApiOpenAIClient::RunStreamEventOneOf5](docs/RunStreamEventOneOf5.md)
|
|
372
|
+
- [OpenApiOpenAIClient::RunStreamEventOneOf6](docs/RunStreamEventOneOf6.md)
|
|
373
|
+
- [OpenApiOpenAIClient::RunStreamEventOneOf7](docs/RunStreamEventOneOf7.md)
|
|
374
|
+
- [OpenApiOpenAIClient::RunStreamEventOneOf8](docs/RunStreamEventOneOf8.md)
|
|
375
|
+
- [OpenApiOpenAIClient::RunToolCallObject](docs/RunToolCallObject.md)
|
|
376
|
+
- [OpenApiOpenAIClient::RunToolCallObjectFunction](docs/RunToolCallObjectFunction.md)
|
|
377
|
+
- [OpenApiOpenAIClient::SubmitToolOutputsRunRequest](docs/SubmitToolOutputsRunRequest.md)
|
|
378
|
+
- [OpenApiOpenAIClient::SubmitToolOutputsRunRequestToolOutputsInner](docs/SubmitToolOutputsRunRequestToolOutputsInner.md)
|
|
379
|
+
- [OpenApiOpenAIClient::ThreadObject](docs/ThreadObject.md)
|
|
380
|
+
- [OpenApiOpenAIClient::ThreadStreamEvent](docs/ThreadStreamEvent.md)
|
|
381
|
+
- [OpenApiOpenAIClient::ThreadStreamEventOneOf](docs/ThreadStreamEventOneOf.md)
|
|
382
|
+
- [OpenApiOpenAIClient::TranscriptionSegment](docs/TranscriptionSegment.md)
|
|
383
|
+
- [OpenApiOpenAIClient::TranscriptionWord](docs/TranscriptionWord.md)
|
|
384
|
+
- [OpenApiOpenAIClient::TruncationObject](docs/TruncationObject.md)
|
|
166
385
|
|
|
167
386
|
|
|
168
387
|
## Documentation for Authorization
|
|
169
388
|
|
|
170
|
-
|
|
389
|
+
|
|
390
|
+
Authentication schemes defined for the API:
|
|
391
|
+
### ApiKeyAuth
|
|
392
|
+
|
|
393
|
+
- **Type**: Bearer authentication
|
|
171
394
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# OpenApiOpenAIClient::AssistantFileObject
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The identifier, which can be referenced in API endpoints. | |
|
|
8
|
+
| **object** | **String** | The object type, which is always `assistant.file`. | |
|
|
9
|
+
| **created_at** | **Integer** | The Unix timestamp (in seconds) for when the assistant file was created. | |
|
|
10
|
+
| **assistant_id** | **String** | The assistant ID that the file is attached to. | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'openapi_openai'
|
|
16
|
+
|
|
17
|
+
instance = OpenApiOpenAIClient::AssistantFileObject.new(
|
|
18
|
+
id: null,
|
|
19
|
+
object: null,
|
|
20
|
+
created_at: null,
|
|
21
|
+
assistant_id: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# OpenApiOpenAIClient::AssistantObject
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The identifier, which can be referenced in API endpoints. | |
|
|
8
|
+
| **object** | **String** | The object type, which is always `assistant`. | |
|
|
9
|
+
| **created_at** | **Integer** | The Unix timestamp (in seconds) for when the assistant was created. | |
|
|
10
|
+
| **name** | **String** | The name of the assistant. The maximum length is 256 characters. | |
|
|
11
|
+
| **description** | **String** | The description of the assistant. The maximum length is 512 characters. | |
|
|
12
|
+
| **model** | **String** | ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. | |
|
|
13
|
+
| **instructions** | **String** | The system instructions that the assistant uses. The maximum length is 256,000 characters. | |
|
|
14
|
+
| **tools** | [**Array<AssistantObjectToolsInner>**](AssistantObjectToolsInner.md) | A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`. | |
|
|
15
|
+
| **file_ids** | **Array<String>** | A list of [file](/docs/api-reference/files) IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order. | |
|
|
16
|
+
| **metadata** | **Object** | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. | |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'openapi_openai'
|
|
22
|
+
|
|
23
|
+
instance = OpenApiOpenAIClient::AssistantObject.new(
|
|
24
|
+
id: null,
|
|
25
|
+
object: null,
|
|
26
|
+
created_at: null,
|
|
27
|
+
name: null,
|
|
28
|
+
description: null,
|
|
29
|
+
model: null,
|
|
30
|
+
instructions: null,
|
|
31
|
+
tools: null,
|
|
32
|
+
file_ids: null,
|
|
33
|
+
metadata: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# OpenApiOpenAIClient::AssistantObjectToolsInner
|
|
2
|
+
|
|
3
|
+
## Class instance methods
|
|
4
|
+
|
|
5
|
+
### `openapi_one_of`
|
|
6
|
+
|
|
7
|
+
Returns the list of classes defined in oneOf.
|
|
8
|
+
|
|
9
|
+
#### Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'openapi_openai'
|
|
13
|
+
|
|
14
|
+
OpenApiOpenAIClient::AssistantObjectToolsInner.openapi_one_of
|
|
15
|
+
# =>
|
|
16
|
+
# [
|
|
17
|
+
# :'AssistantToolsCode',
|
|
18
|
+
# :'AssistantToolsFunction',
|
|
19
|
+
# :'AssistantToolsRetrieval'
|
|
20
|
+
# ]
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### build
|
|
24
|
+
|
|
25
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
|
26
|
+
|
|
27
|
+
#### Example
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
require 'openapi_openai'
|
|
31
|
+
|
|
32
|
+
OpenApiOpenAIClient::AssistantObjectToolsInner.build(data)
|
|
33
|
+
# => #<AssistantToolsCode:0x00007fdd4aab02a0>
|
|
34
|
+
|
|
35
|
+
OpenApiOpenAIClient::AssistantObjectToolsInner.build(data_that_doesnt_match)
|
|
36
|
+
# => nil
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
#### Parameters
|
|
40
|
+
|
|
41
|
+
| Name | Type | Description |
|
|
42
|
+
| ---- | ---- | ----------- |
|
|
43
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
|
44
|
+
|
|
45
|
+
#### Return type
|
|
46
|
+
|
|
47
|
+
- `AssistantToolsCode`
|
|
48
|
+
- `AssistantToolsFunction`
|
|
49
|
+
- `AssistantToolsRetrieval`
|
|
50
|
+
- `nil` (if no type matches)
|
|
51
|
+
|