View Source API Reference ex_openai.ex v1.8.0

Auto-generated SDK for OpenAI APIs See https://platform.openai.com/docs/api-reference/introduction for further info on REST endpoints Make sure to refer to the README on Github to see what is implemented and what isn't yet

Modules for interacting with the assistants group of OpenAI APIs

Modules for interacting with the audio group of OpenAI APIs

Modules for interacting with the batches group of OpenAI APIs

Modules for interacting with the chat group of OpenAI APIs

Modules for interacting with the completions group of OpenAI APIs

Schema representing a AddUploadPartRequest within the OpenAI API

Schema representing a AdminApiKey within the OpenAI API

Schema representing a Annotation within the OpenAI API

Schema representing a ApiKeyList within the OpenAI API

Schema representing a AssistantObject within the OpenAI API

Schema representing a AssistantStreamEvent within the OpenAI API

Schema representing a AssistantSupportedModels within the OpenAI API

Schema representing a AssistantToolsCode within the OpenAI API

Schema representing a AssistantToolsFileSearch within the OpenAI API

Schema representing a AssistantToolsFileSearchTypeOnly within the OpenAI API

Schema representing a AssistantToolsFunction within the OpenAI API

Schema representing a AssistantsApiResponseFormatOption within the OpenAI API

Schema representing a AssistantsApiToolChoiceOption within the OpenAI API

Schema representing a AssistantsNamedToolChoice within the OpenAI API

Schema representing a AudioResponseFormat within the OpenAI API

Schema representing a AuditLog within the OpenAI API

Schema representing a AuditLogActor within the OpenAI API

Schema representing a AuditLogActorApiKey within the OpenAI API

Schema representing a AuditLogActorServiceAccount within the OpenAI API

Schema representing a AuditLogActorSession within the OpenAI API

Schema representing a AuditLogActorUser within the OpenAI API

Schema representing a AuditLogEventType within the OpenAI API

Schema representing a AutoChunkingStrategyRequestParam within the OpenAI API

Schema representing a Batch within the OpenAI API

Schema representing a BatchRequestInput within the OpenAI API

Schema representing a BatchRequestOutput within the OpenAI API

Schema representing a CancelUploadRequest within the OpenAI API

Schema representing a ChatCompletionDeleted within the OpenAI API

Schema representing a ChatCompletionFunctionCallOption within the OpenAI API

Schema representing a ChatCompletionFunctions within the OpenAI API

Schema representing a ChatCompletionList within the OpenAI API

Schema representing a ChatCompletionMessageList within the OpenAI API

Schema representing a ChatCompletionMessageToolCall within the OpenAI API

Schema representing a ChatCompletionMessageToolCallChunk within the OpenAI API

Schema representing a ChatCompletionMessageToolCalls within the OpenAI API

Schema representing a ChatCompletionModalities within the OpenAI API

Schema representing a ChatCompletionNamedToolChoice within the OpenAI API

Schema representing a ChatCompletionRequestAssistantMessage within the OpenAI API

Schema representing a ChatCompletionRequestAssistantMessageContentPart within the OpenAI API

Schema representing a ChatCompletionRequestDeveloperMessage within the OpenAI API

Schema representing a ChatCompletionRequestFunctionMessage within the OpenAI API

Schema representing a ChatCompletionRequestMessage within the OpenAI API

Schema representing a ChatCompletionRequestMessageContentPartAudio within the OpenAI API

Schema representing a ChatCompletionRequestMessageContentPartFile within the OpenAI API

Schema representing a ChatCompletionRequestMessageContentPartImage within the OpenAI API

Schema representing a ChatCompletionRequestMessageContentPartRefusal within the OpenAI API

Schema representing a ChatCompletionRequestMessageContentPartText within the OpenAI API

Schema representing a ChatCompletionRequestSystemMessage within the OpenAI API

Schema representing a ChatCompletionRequestSystemMessageContentPart within the OpenAI API

Schema representing a ChatCompletionRequestToolMessage within the OpenAI API

Schema representing a ChatCompletionRequestToolMessageContentPart within the OpenAI API

Schema representing a ChatCompletionRequestUserMessage within the OpenAI API

Schema representing a ChatCompletionRequestUserMessageContentPart within the OpenAI API

Schema representing a ChatCompletionResponseMessage within the OpenAI API

Schema representing a ChatCompletionRole within the OpenAI API

Schema representing a ChatCompletionStreamOptions within the OpenAI API

Schema representing a ChatCompletionStreamResponseDelta within the OpenAI API

Schema representing a ChatCompletionTokenLogprob within the OpenAI API

Schema representing a ChatCompletionTool within the OpenAI API

Schema representing a ChatCompletionToolChoiceOption within the OpenAI API

Schema representing a ChunkingStrategyRequestParam within the OpenAI API

Schema representing a Click within the OpenAI API

Schema representing a CodeInterpreterFileOutput within the OpenAI API

Schema representing a CodeInterpreterTextOutput within the OpenAI API

Schema representing a CodeInterpreterTool within the OpenAI API

Schema representing a CodeInterpreterToolCall within the OpenAI API

Schema representing a CodeInterpreterToolOutput within the OpenAI API

Schema representing a ComparisonFilter within the OpenAI API

Schema representing a CompleteUploadRequest within the OpenAI API

Schema representing a CompletionUsage within the OpenAI API

Schema representing a CompoundFilter within the OpenAI API

Schema representing a ComputerAction within the OpenAI API

Schema representing a ComputerScreenshotImage within the OpenAI API

Schema representing a ComputerTool within the OpenAI API

Schema representing a ComputerToolCall within the OpenAI API

Schema representing a ComputerToolCallOutput within the OpenAI API

Schema representing a ComputerToolCallOutputResource within the OpenAI API

Schema representing a ComputerToolCallSafetyCheck within the OpenAI API

Schema representing a Content within the OpenAI API

Schema representing a Coordinate within the OpenAI API

Schema representing a CostsResult within the OpenAI API

Schema representing a CreateAssistantRequest within the OpenAI API

Schema representing a CreateChatCompletionFunctionResponse within the OpenAI API

Schema representing a CreateChatCompletionImageResponse within the OpenAI API

Schema representing a CreateChatCompletionRequest within the OpenAI API

Schema representing a CreateChatCompletionResponse within the OpenAI API

Schema representing a CreateChatCompletionStreamResponse within the OpenAI API

Schema representing a CreateCompletionRequest within the OpenAI API

Schema representing a CreateCompletionResponse within the OpenAI API

Schema representing a CreateEmbeddingRequest within the OpenAI API

Schema representing a CreateEmbeddingResponse within the OpenAI API

Schema representing a CreateFileRequest within the OpenAI API

Schema representing a CreateFineTuningJobRequest within the OpenAI API

Schema representing a CreateImageEditRequest within the OpenAI API

Schema representing a CreateImageRequest within the OpenAI API

Schema representing a CreateImageVariationRequest within the OpenAI API

Schema representing a CreateMessageRequest within the OpenAI API

Schema representing a CreateModelResponseProperties within the OpenAI API

Schema representing a CreateModerationRequest within the OpenAI API

Schema representing a CreateModerationResponse within the OpenAI API

Schema representing a CreateResponse within the OpenAI API

Schema representing a CreateRunRequest within the OpenAI API

Schema representing a CreateSpeechRequest within the OpenAI API

Schema representing a CreateThreadAndRunRequest within the OpenAI API

Schema representing a CreateThreadRequest within the OpenAI API

Schema representing a CreateTranscriptionRequest within the OpenAI API

Schema representing a CreateTranscriptionResponseJson within the OpenAI API

Schema representing a CreateTranscriptionResponseVerboseJson within the OpenAI API

Schema representing a CreateTranslationRequest within the OpenAI API

Schema representing a CreateTranslationResponseJson within the OpenAI API

Schema representing a CreateTranslationResponseVerboseJson within the OpenAI API

Schema representing a CreateUploadRequest within the OpenAI API

Schema representing a CreateVectorStoreFileBatchRequest within the OpenAI API

Schema representing a CreateVectorStoreFileRequest within the OpenAI API

Schema representing a CreateVectorStoreRequest within the OpenAI API

Schema representing a DefaultProjectErrorResponse within the OpenAI API

Schema representing a DeleteAssistantResponse within the OpenAI API

Schema representing a DeleteFileResponse within the OpenAI API

Schema representing a DeleteMessageResponse within the OpenAI API

Schema representing a DeleteModelResponse within the OpenAI API

Schema representing a DeleteThreadResponse within the OpenAI API

Schema representing a DeleteVectorStoreFileResponse within the OpenAI API

Schema representing a DeleteVectorStoreResponse within the OpenAI API

Schema representing a DoneEvent within the OpenAI API

Schema representing a DoubleClick within the OpenAI API

Schema representing a Drag within the OpenAI API

Schema representing a EasyInputMessage within the OpenAI API

Schema representing a Embedding within the OpenAI API

Schema representing a Error within the OpenAI API

Schema representing a ErrorEvent within the OpenAI API

Schema representing a ErrorResponse within the OpenAI API

Schema representing a FileCitation within the OpenAI API

Schema representing a FilePath within the OpenAI API

Schema representing a FileSearchRanker within the OpenAI API

Schema representing a FileSearchRankingOptions within the OpenAI API

Schema representing a FileSearchTool within the OpenAI API

Schema representing a FileSearchToolCall within the OpenAI API

Schema representing a FineTuneChatCompletionRequestAssistantMessage within the OpenAI API

Schema representing a FineTuneChatRequestInput within the OpenAI API

Schema representing a FineTuneCompletionRequestInput within the OpenAI API

Schema representing a FineTuneDPOMethod within the OpenAI API

Schema representing a FineTuneMethod within the OpenAI API

Schema representing a FineTunePreferenceRequestInput within the OpenAI API

Schema representing a FineTuneSupervisedMethod within the OpenAI API

Schema representing a FineTuningIntegration within the OpenAI API

Schema representing a FineTuningJob within the OpenAI API

Schema representing a FineTuningJobCheckpoint within the OpenAI API

Schema representing a FineTuningJobEvent within the OpenAI API

Schema representing a FunctionObject within the OpenAI API

Schema representing a FunctionParameters within the OpenAI API

Schema representing a FunctionTool within the OpenAI API

Schema representing a FunctionToolCall within the OpenAI API

Schema representing a FunctionToolCallOutput within the OpenAI API

Schema representing a FunctionToolCallOutputResource within the OpenAI API

Schema representing a Image within the OpenAI API

Schema representing a ImagesResponse within the OpenAI API

Schema representing a Includable within the OpenAI API

Schema representing a InputAudio within the OpenAI API

Schema representing a InputContent within the OpenAI API

Schema representing a InputFile within the OpenAI API

Schema representing a InputImage within the OpenAI API

Schema representing a InputItem within the OpenAI API

Schema representing a InputMessage within the OpenAI API

Schema representing a InputMessageContentList within the OpenAI API

Schema representing a InputMessageResource within the OpenAI API

Schema representing a InputText within the OpenAI API

Schema representing a Invite within the OpenAI API

Schema representing a InviteDeleteResponse within the OpenAI API

Schema representing a InviteListResponse within the OpenAI API

Schema representing a InviteRequest within the OpenAI API

Schema representing a Item within the OpenAI API

Schema representing a ItemReference within the OpenAI API

Schema representing a ItemResource within the OpenAI API

Schema representing a KeyPress within the OpenAI API

Schema representing a ListAssistantsResponse within the OpenAI API

Schema representing a ListAuditLogsResponse within the OpenAI API

Schema representing a ListBatchesResponse within the OpenAI API

Schema representing a ListFilesResponse within the OpenAI API

Schema representing a ListFineTuningJobCheckpointsResponse within the OpenAI API

Schema representing a ListFineTuningJobEventsResponse within the OpenAI API

Schema representing a ListMessagesResponse within the OpenAI API

Schema representing a ListModelsResponse within the OpenAI API

Schema representing a ListPaginatedFineTuningJobsResponse within the OpenAI API

Schema representing a ListRunStepsResponse within the OpenAI API

Schema representing a ListRunsResponse within the OpenAI API

Schema representing a ListThreadsResponse within the OpenAI API

Schema representing a ListVectorStoreFilesResponse within the OpenAI API

Schema representing a ListVectorStoresResponse within the OpenAI API

Schema representing a LogProb within the OpenAI API

Schema representing a LogProbProperties within the OpenAI API

Schema representing a MessageContentImageFileObject within the OpenAI API

Schema representing a MessageContentImageUrlObject within the OpenAI API

Schema representing a MessageContentRefusalObject within the OpenAI API

Schema representing a MessageContentTextAnnotationsFileCitationObject within the OpenAI API

Schema representing a MessageContentTextAnnotationsFilePathObject within the OpenAI API

Schema representing a MessageContentTextObject within the OpenAI API

Schema representing a MessageDeltaContentImageFileObject within the OpenAI API

Schema representing a MessageDeltaContentImageUrlObject within the OpenAI API

Schema representing a MessageDeltaContentRefusalObject within the OpenAI API

Schema representing a MessageDeltaContentTextAnnotationsFileCitationObject within the OpenAI API

Schema representing a MessageDeltaContentTextAnnotationsFilePathObject within the OpenAI API

Schema representing a MessageDeltaContentTextObject within the OpenAI API

Schema representing a MessageDeltaObject within the OpenAI API

Schema representing a MessageObject within the OpenAI API

Schema representing a MessageRequestContentTextObject within the OpenAI API

Schema representing a MessageStreamEvent within the OpenAI API

Schema representing a Metadata within the OpenAI API

Replacement Component for Model API responses This module was not part of the api documentation and got probably forgotten, so it has been manually provided by this package Rpresents API responses such as

Schema representing a ModelIds within the OpenAI API

Schema representing a ModelResponseProperties within the OpenAI API

Schema representing a ModifyAssistantRequest within the OpenAI API

Schema representing a ModifyMessageRequest within the OpenAI API

Schema representing a ModifyRunRequest within the OpenAI API

Schema representing a ModifyThreadRequest within the OpenAI API

Schema representing a Move within the OpenAI API

Schema representing a OpenAIFile within the OpenAI API

Schema representing a OtherChunkingStrategyResponseParam within the OpenAI API

Schema representing a OutputAudio within the OpenAI API

Schema representing a OutputContent within the OpenAI API

Schema representing a OutputItem within the OpenAI API

Schema representing a OutputMessage within the OpenAI API

Schema representing a OutputText within the OpenAI API

Schema representing a ParallelToolCalls within the OpenAI API

Schema representing a PredictionContent within the OpenAI API

Schema representing a Project within the OpenAI API

Schema representing a ProjectApiKey within the OpenAI API

Schema representing a ProjectApiKeyDeleteResponse within the OpenAI API

Schema representing a ProjectApiKeyListResponse within the OpenAI API

Schema representing a ProjectCreateRequest within the OpenAI API

Schema representing a ProjectListResponse within the OpenAI API

Schema representing a ProjectRateLimit within the OpenAI API

Schema representing a ProjectRateLimitListResponse within the OpenAI API

Schema representing a ProjectRateLimitUpdateRequest within the OpenAI API

Schema representing a ProjectServiceAccount within the OpenAI API

Schema representing a ProjectServiceAccountApiKey within the OpenAI API

Schema representing a ProjectServiceAccountCreateRequest within the OpenAI API

Schema representing a ProjectServiceAccountCreateResponse within the OpenAI API

Schema representing a ProjectServiceAccountDeleteResponse within the OpenAI API

Schema representing a ProjectServiceAccountListResponse within the OpenAI API

Schema representing a ProjectUpdateRequest within the OpenAI API

Schema representing a ProjectUser within the OpenAI API

Schema representing a ProjectUserCreateRequest within the OpenAI API

Schema representing a ProjectUserDeleteResponse within the OpenAI API

Schema representing a ProjectUserListResponse within the OpenAI API

Schema representing a ProjectUserUpdateRequest within the OpenAI API

Schema representing a RealtimeClientEventConversationItemCreate within the OpenAI API

Schema representing a RealtimeClientEventConversationItemDelete within the OpenAI API

Schema representing a RealtimeClientEventConversationItemTruncate within the OpenAI API

Schema representing a RealtimeClientEventInputAudioBufferAppend within the OpenAI API

Schema representing a RealtimeClientEventInputAudioBufferClear within the OpenAI API

Schema representing a RealtimeClientEventInputAudioBufferCommit within the OpenAI API

Schema representing a RealtimeClientEventResponseCancel within the OpenAI API

Schema representing a RealtimeClientEventResponseCreate within the OpenAI API

Schema representing a RealtimeClientEventSessionUpdate within the OpenAI API

Schema representing a RealtimeConversationItem within the OpenAI API

Schema representing a RealtimeConversationItemWithReference within the OpenAI API

Schema representing a RealtimeResponse within the OpenAI API

Schema representing a RealtimeResponseCreateParams within the OpenAI API

Schema representing a RealtimeServerEventConversationCreated within the OpenAI API

Schema representing a RealtimeServerEventConversationItemCreated within the OpenAI API

Schema representing a RealtimeServerEventConversationItemDeleted within the OpenAI API

Schema representing a RealtimeServerEventConversationItemInputAudioTranscriptionCompleted within the OpenAI API

Schema representing a RealtimeServerEventConversationItemInputAudioTranscriptionFailed within the OpenAI API

Schema representing a RealtimeServerEventConversationItemTruncated within the OpenAI API

Schema representing a RealtimeServerEventError within the OpenAI API

Schema representing a RealtimeServerEventInputAudioBufferCleared within the OpenAI API

Schema representing a RealtimeServerEventInputAudioBufferCommitted within the OpenAI API

Schema representing a RealtimeServerEventInputAudioBufferSpeechStarted within the OpenAI API

Schema representing a RealtimeServerEventInputAudioBufferSpeechStopped within the OpenAI API

Schema representing a RealtimeServerEventRateLimitsUpdated within the OpenAI API

Schema representing a RealtimeServerEventResponseAudioDelta within the OpenAI API

Schema representing a RealtimeServerEventResponseAudioDone within the OpenAI API

Schema representing a RealtimeServerEventResponseAudioTranscriptDelta within the OpenAI API

Schema representing a RealtimeServerEventResponseAudioTranscriptDone within the OpenAI API

Schema representing a RealtimeServerEventResponseContentPartAdded within the OpenAI API

Schema representing a RealtimeServerEventResponseContentPartDone within the OpenAI API

Schema representing a RealtimeServerEventResponseCreated within the OpenAI API

Schema representing a RealtimeServerEventResponseDone within the OpenAI API

Schema representing a RealtimeServerEventResponseFunctionCallArgumentsDelta within the OpenAI API

Schema representing a RealtimeServerEventResponseFunctionCallArgumentsDone within the OpenAI API

Schema representing a RealtimeServerEventResponseOutputItemAdded within the OpenAI API

Schema representing a RealtimeServerEventResponseOutputItemDone within the OpenAI API

Schema representing a RealtimeServerEventResponseTextDelta within the OpenAI API

Schema representing a RealtimeServerEventResponseTextDone within the OpenAI API

Schema representing a RealtimeServerEventSessionCreated within the OpenAI API

Schema representing a RealtimeServerEventSessionUpdated within the OpenAI API

Schema representing a RealtimeSession within the OpenAI API

Schema representing a RealtimeSessionCreateRequest within the OpenAI API

Schema representing a RealtimeSessionCreateResponse within the OpenAI API

Schema representing a Reasoning within the OpenAI API

Schema representing a ReasoningEffort within the OpenAI API

Schema representing a ReasoningItem within the OpenAI API

Schema representing a Refusal within the OpenAI API

Schema representing a Response within the OpenAI API

Schema representing a ResponseAudioDeltaEvent within the OpenAI API

Schema representing a ResponseAudioDoneEvent within the OpenAI API

Schema representing a ResponseAudioTranscriptDeltaEvent within the OpenAI API

Schema representing a ResponseAudioTranscriptDoneEvent within the OpenAI API

Schema representing a ResponseCodeInterpreterCallCodeDeltaEvent within the OpenAI API

Schema representing a ResponseCodeInterpreterCallCodeDoneEvent within the OpenAI API

Schema representing a ResponseCodeInterpreterCallCompletedEvent within the OpenAI API

Schema representing a ResponseCodeInterpreterCallInProgressEvent within the OpenAI API

Schema representing a ResponseCodeInterpreterCallInterpretingEvent within the OpenAI API

Schema representing a ResponseCompletedEvent within the OpenAI API

Schema representing a ResponseContentPartAddedEvent within the OpenAI API

Schema representing a ResponseContentPartDoneEvent within the OpenAI API

Schema representing a ResponseCreatedEvent within the OpenAI API

Schema representing a ResponseError within the OpenAI API

Schema representing a ResponseErrorCode within the OpenAI API

Schema representing a ResponseErrorEvent within the OpenAI API

Schema representing a ResponseFailedEvent within the OpenAI API

Schema representing a ResponseFileSearchCallCompletedEvent within the OpenAI API

Schema representing a ResponseFileSearchCallInProgressEvent within the OpenAI API

Schema representing a ResponseFileSearchCallSearchingEvent within the OpenAI API

Schema representing a ResponseFormatJsonObject within the OpenAI API

Schema representing a ResponseFormatJsonSchema within the OpenAI API

Schema representing a ResponseFormatJsonSchemaSchema within the OpenAI API

Schema representing a ResponseFormatText within the OpenAI API

Schema representing a ResponseFunctionCallArgumentsDeltaEvent within the OpenAI API

Schema representing a ResponseFunctionCallArgumentsDoneEvent within the OpenAI API

Schema representing a ResponseInProgressEvent within the OpenAI API

Schema representing a ResponseIncompleteEvent within the OpenAI API

Schema representing a ResponseItemList within the OpenAI API

Schema representing a ResponseModalities within the OpenAI API

Schema representing a ResponseModalitiesTextOnly within the OpenAI API

Schema representing a ResponseOutputItemAddedEvent within the OpenAI API

Schema representing a ResponseOutputItemDoneEvent within the OpenAI API

Schema representing a ResponseProperties within the OpenAI API

Schema representing a ResponseRefusalDeltaEvent within the OpenAI API

Schema representing a ResponseRefusalDoneEvent within the OpenAI API

Schema representing a ResponseStreamEvent within the OpenAI API

Schema representing a ResponseTextAnnotationDeltaEvent within the OpenAI API

Schema representing a ResponseTextDeltaEvent within the OpenAI API

Schema representing a ResponseTextDoneEvent within the OpenAI API

Schema representing a ResponseUsage within the OpenAI API

Schema representing a ResponseWebSearchCallCompletedEvent within the OpenAI API

Schema representing a ResponseWebSearchCallInProgressEvent within the OpenAI API

Schema representing a ResponseWebSearchCallSearchingEvent within the OpenAI API

Schema representing a RunCompletionUsage within the OpenAI API

Schema representing a RunObject within the OpenAI API

Schema representing a RunStepCompletionUsage within the OpenAI API

Schema representing a RunStepDeltaObject within the OpenAI API

Schema representing a RunStepDeltaStepDetailsMessageCreationObject within the OpenAI API

Schema representing a RunStepDeltaStepDetailsToolCallsCodeObject within the OpenAI API

Schema representing a RunStepDeltaStepDetailsToolCallsCodeOutputImageObject within the OpenAI API

Schema representing a RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject within the OpenAI API

Schema representing a RunStepDeltaStepDetailsToolCallsFileSearchObject within the OpenAI API

Schema representing a RunStepDeltaStepDetailsToolCallsFunctionObject within the OpenAI API

Schema representing a RunStepDeltaStepDetailsToolCallsObject within the OpenAI API

Schema representing a RunStepDetailsMessageCreationObject within the OpenAI API

Schema representing a RunStepDetailsToolCallsCodeObject within the OpenAI API

Schema representing a RunStepDetailsToolCallsCodeOutputImageObject within the OpenAI API

Schema representing a RunStepDetailsToolCallsCodeOutputLogsObject within the OpenAI API

Schema representing a RunStepDetailsToolCallsFileSearchObject within the OpenAI API

Schema representing a RunStepDetailsToolCallsFileSearchRankingOptionsObject within the OpenAI API

Schema representing a RunStepDetailsToolCallsFileSearchResultObject within the OpenAI API

Schema representing a RunStepDetailsToolCallsFunctionObject within the OpenAI API

Schema representing a RunStepDetailsToolCallsObject within the OpenAI API

Schema representing a RunStepObject within the OpenAI API

Schema representing a RunStepStreamEvent within the OpenAI API

Schema representing a RunStreamEvent within the OpenAI API

Schema representing a RunToolCallObject within the OpenAI API

Schema representing a Screenshot within the OpenAI API

Schema representing a Scroll within the OpenAI API

Schema representing a StaticChunkingStrategy within the OpenAI API

Schema representing a StaticChunkingStrategyRequestParam within the OpenAI API

Schema representing a StaticChunkingStrategyResponseParam within the OpenAI API

Schema representing a StopConfiguration within the OpenAI API

Schema representing a SubmitToolOutputsRunRequest within the OpenAI API

Schema representing a TextResponseFormatConfiguration within the OpenAI API

Schema representing a TextResponseFormatJsonSchema within the OpenAI API

Schema representing a ThreadObject within the OpenAI API

Schema representing a ThreadStreamEvent within the OpenAI API

Schema representing a Tool within the OpenAI API

Schema representing a ToolChoiceFunction within the OpenAI API

Schema representing a ToolChoiceOptions within the OpenAI API

Schema representing a ToolChoiceTypes within the OpenAI API

Schema representing a TranscriptionSegment within the OpenAI API

Schema representing a TranscriptionWord within the OpenAI API

Schema representing a TruncationObject within the OpenAI API

Schema representing a Type within the OpenAI API

Schema representing a UpdateVectorStoreFileAttributesRequest within the OpenAI API

Schema representing a UpdateVectorStoreRequest within the OpenAI API

Schema representing a Upload within the OpenAI API

Schema representing a UploadPart within the OpenAI API

Schema representing a UrlCitation within the OpenAI API

Schema representing a UsageAudioSpeechesResult within the OpenAI API

Schema representing a UsageAudioTranscriptionsResult within the OpenAI API

Schema representing a UsageCodeInterpreterSessionsResult within the OpenAI API

Schema representing a UsageCompletionsResult within the OpenAI API

Schema representing a UsageEmbeddingsResult within the OpenAI API

Schema representing a UsageImagesResult within the OpenAI API

Schema representing a UsageModerationsResult within the OpenAI API

Schema representing a UsageResponse within the OpenAI API

Schema representing a UsageTimeBucket within the OpenAI API

Schema representing a UsageVectorStoresResult within the OpenAI API

Schema representing a User within the OpenAI API

Schema representing a UserDeleteResponse within the OpenAI API

Schema representing a UserListResponse within the OpenAI API

Schema representing a UserRoleUpdateRequest within the OpenAI API

Schema representing a VectorStoreExpirationAfter within the OpenAI API

Schema representing a VectorStoreFileAttributes within the OpenAI API

Schema representing a VectorStoreFileBatchObject within the OpenAI API

Schema representing a VectorStoreFileContentResponse within the OpenAI API

Schema representing a VectorStoreFileObject within the OpenAI API

Schema representing a VectorStoreObject within the OpenAI API

Schema representing a VectorStoreSearchRequest within the OpenAI API

Schema representing a VectorStoreSearchResultContentObject within the OpenAI API

Schema representing a VectorStoreSearchResultItem within the OpenAI API

Schema representing a VectorStoreSearchResultsPage within the OpenAI API

Schema representing a Wait within the OpenAI API

Schema representing a WebSearchContextSize within the OpenAI API

Schema representing a WebSearchLocation within the OpenAI API

Schema representing a WebSearchTool within the OpenAI API

Schema representing a WebSearchToolCall within the OpenAI API

Reads configuration on application start, parses all environment variables (if any) and caches the final config in memory to avoid parsing on each read afterwards.

Modules for interacting with the embeddings group of OpenAI APIs

Modules for interacting with the files group of OpenAI APIs

Modules for interacting with the fine_tuning group of OpenAI APIs

Modules for interacting with the images group of OpenAI APIs

Modules for interacting with the models group of OpenAI APIs

Modules for interacting with the moderations group of OpenAI APIs

Modules for interacting with the organization group of OpenAI APIs

Modules for interacting with the realtime group of OpenAI APIs

Modules for interacting with the responses group of OpenAI APIs

Modules for interacting with the threads group of OpenAI APIs

Modules for interacting with the uploads group of OpenAI APIs

Modules for interacting with the vector_stores group of OpenAI APIs

Updates OpenAI API documentation files