JavaScript is disabled on your browser.
Skip navigation links
Overview
Package
Class
Use
Tree
Deprecated
Index
All Classes
SEARCH:
JavaScript is disabled on your browser.
All Classes
All Classes
Interface Summary
Class Summary
Enum Summary
Exception Summary
Annotation Types Summary
Class
Description
AbstractImageRequest
Action
Assistant
AssistantModifyRequest
AssistantRequest
AssistantServices
AssistantStreamEvent
AssistantTool
AssistantTool.FileSearch
Attachment
Attachment.AttachmentTool
AudioFormat
AudioResponseFormat
AudioServices
Base64Util
Base64Util.MediaType
BaseEvent
Batch
Batch.BatchError
Batch.BatchErrors
Batch.RequestCountsType
BatchRequest
BatchRequest.CompletionWindowType
BatchServices
Chat
Chat.Choice
Chat.Choice.LogprobInfo
Chat.Choice.LogprobInfo.TokenLogprob
Chat.Choice.LogprobInfo.TopLogprob
ChatCompletionServices
ChatMessage
ChatMessage.AssistantMessage
ChatMessage.AssistantMessage.Audio
ChatMessage.ChatRole
ChatMessage.DeveloperMessage
ChatMessage.ResponseMessage
ChatMessage.ResponseMessage.AudioResponse
ChatMessage.SystemMessage
ChatMessage.ToolMessage
ChatMessage.UserMessage
ChatRequest
ChatRequest.Audio
ChatRequest.Modality
ChatRequest.ReasoningEffort
ChatRequest.ServiceTier
ChunkingStrategy
ChunkingStrategy.ChunkingStrategyType
ChunkingStrategy.StaticChunking
ClientConfig
ClientEvent
ClientEvent.ConversationItemCreate
ClientEvent.ConversationItemDelete
ClientEvent.ConversationItemTruncate
ClientEvent.InputAudioBufferAppend
ClientEvent.InputAudioBufferClear
ClientEvent.InputAudioBufferCommit
ClientEvent.ResponseCancel
ClientEvent.ResponseCreate
ClientEvent.SessionUpdate
Completion
Completion.Choice
Completion.Choice.LogProbs
CompletionRequest
CompletionServices
Constant
ContentPart
ContentPart.ChatContentPart
ContentPart.ContentPartImageFile
ContentPart.ContentPartImageFile.ImageFile
ContentPart.ContentPartImageUrl
ContentPart.ContentPartImageUrl.ImageUrl
ContentPart.ContentPartInputAudio
ContentPart.ContentPartInputAudio.InputAudio
ContentPart.ContentPartRefusal
ContentPart.ContentPartText
ContentPart.ContentPartTextAnnotation
ContentPart.ContentPartTextAnnotation.TextAnnotation
ContentPart.ContentPartType
DefaultSchemaConverter
DeletedObject
Embedding
<
T
>
EmbeddingBase64
EmbeddingFloat
EmbeddingRequest
EmbeddingRequest.EncodingFormat
EmbeddingServices
EndpointType
EventName
ExpiresAfter
ExpiresAfter.Anchor
FileAnnotation
FileAnnotation.AnnotationType
FileAnnotation.FileCitationAnnotation
FileAnnotation.FileCitationAnnotation.FileCitation
FileAnnotation.FilePathAnnotation
FileAnnotation.FilePathAnnotation.FilePath
FileCount
FileRequest
FileRequest.PurposeType
FileResponse
FileServices
FileStatus
FineTuning
FineTuning.FineTuningError
FineTuningCheckpoint
FineTuningCheckpoint.Metrics
FineTuningEvent
FineTuningRequest
FineTunningServices
Functional
FunctionCall
FunctionDef
FunctionExecutor
Generic
<
T
>
HyperParams
Image
ImageDetail
ImageEditsRequest
ImageRequest
ImageRequest.Quality
ImageRequest.Style
ImageResponseFormat
ImageServices
ImageVariationsRequest
IncompleteDetail
IncompleteDetail.IncompleteDetailReason
InputAudioFormat
Integration
Integration.IntegrationType
Integration.WandbIntegration
Item
Item.ContentItem
Item.ContentItemType
Item.ItemType
Item.RoleItemMessage
JsonSchemaUtil
LastError
MethodFineTunning
MethodFineTunning.Dpo
MethodFineTunning.MethodType
MethodFineTunning.Supervised
Model
ModelServices
Moderation
Moderation.ModerationResult
Moderation.ModerationResult.Category
Moderation.ModerationResult.CategoryScore
ModerationRequest
ModerationServices
OpenAI
The OpenAI API can be applied to virtually any task that requires understanding or generating natural language and code.
OpenAI.Audios
Turn audio into text (speech to text).
OpenAI.Batches
Create large batches of API requests to run asynchronously.
OpenAI.ChatCompletions
Given a list of messages comprising a conversation, the model will return a response.
OpenAI.Completions
Given a prompt, the model will return one or more predicted completions.
OpenAI.Embeddings
Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
OpenAI.Files
Files are used to upload documents that can be used with features like fine-tuning.
OpenAI.FineTunings
Manage fine-tuning jobs to tailor a model to your specific training data.
OpenAI.Images
Given a prompt and/or an input image, the model will generate a new image.
OpenAI.Models
List and describe the various models available in the API.
OpenAI.Moderations
Given a input text, outputs if the model classifies it as violating OpenAI's content policy.
OpenAI.SessionTokens
Generate ephemeral session tokens for use in client-side applications.
OpenAI.Uploads
Allows you to upload large files in multiple parts.
OpenAIBeta2
The Assistants API (Beta v2) allows you to build AI assistants within your own applications.
OpenAIBeta2.Assistants
Build assistants that can call models and use tools to perform tasks.
OpenAIBeta2.ThreadMessages
Create messages within threads.
OpenAIBeta2.ThreadRuns
Represents an execution run on a thread.
OpenAIBeta2.ThreadRunSteps
Represents the steps (model and tool calls) taken during the run.
OpenAIBeta2.Threads
Create threads that assistants can interact with.
OpenAIBeta2.VectorStoreFileBatches
Vector store file batches represent operations to add multiple files to a vector store.
OpenAIBeta2.VectorStoreFiles
Vector store files represent files inside a vector store.
OpenAIBeta2.VectorStores
Vector stores are used to store files for use by the file_search tool.
OpenAIConfigurator
OpenAIException
OpenAIException.AuthenticationException
OpenAIException.BadRequestException
OpenAIException.InternalServerException
OpenAIException.NotFoundException
OpenAIException.PermissionDeniedException
OpenAIException.RateLimitException
OpenAIException.UnexpectedStatusCodeException
OpenAIException.UnprocessableEntityException
OpenAIExceptionConverter
OpenAIProvider
The abstract class that providers must extend.
OpenAIRealtime
OpenAIResponseInfo
OpenAIResponseInfo.OpenAIErrorResponse
OpenAIResponseInfo.OpenAIErrorResponse.OpenAIError
Page
<
T
>
PageRequest
PageRequest.Order
Poller
<
T
>
RankingOption
RankingOption.RankerType
Realtime
RealtimeConfig
RealtimeResponse
RealtimeResponse.ConversationType
RealtimeServices
RealtimeSession
RealtimeSession.AudioFormatRealtime
RealtimeSession.InputAudioTranscription
RealtimeSession.ToolRealtime
RealtimeSession.TurnDetection
RealtimeSession.VoiceRealtime
RealtimeSessionToken
RealtimeSessionToken.Secret
Response
Response.ErrorDetail
Response.StatusDetails
Response.TokenDetails
Response.UsageResponse
ResponseFormat
ResponseFormat.JsonSchema
ResponseFormat.ResponseFormatType
RunStepType
SchemaConverter
ServerEvent
ServerEvent.BaseResponse
ServerEvent.BaseResponseFunctionCallArguments
ServerEvent.Conversation
ServerEvent.ConversationCreated
ServerEvent.ConversationItemAudioTransCompleted
ServerEvent.ConversationItemAudioTransFailed
ServerEvent.ConversationItemCreated
ServerEvent.ConversationItemDeleted
ServerEvent.ConversationItemTruncated
ServerEvent.ErrorDetail
ServerEvent.ErrorEvent
ServerEvent.InputAudioBufferCleared
ServerEvent.InputAudioBufferCommitted
ServerEvent.InputAudioBufferSpeechStarted
ServerEvent.InputAudioBufferSpeechStopped
ServerEvent.Part
ServerEvent.RateLimit
ServerEvent.RateLimitsUpdated
ServerEvent.ResponseAudioDelta
ServerEvent.ResponseAudioDone
ServerEvent.ResponseAudioTranscriptDelta
ServerEvent.ResponseAudioTranscriptDone
ServerEvent.ResponseContentPartAdded
ServerEvent.ResponseContentPartDone
ServerEvent.ResponseCreated
ServerEvent.ResponseDone
ServerEvent.ResponseFunctionCallArgumentsDelta
ServerEvent.ResponseFunctionCallArgumentsDone
ServerEvent.ResponseOutputItemAdded
ServerEvent.ResponseOutputItemDone
ServerEvent.ResponseTextDelta
ServerEvent.ResponseTextDone
ServerEvent.SessionCreated
ServerEvent.SessionUpdated
SessionServices
SimpleOpenAI
The standard OpenAI implementation which implements the full services.
SimpleOpenAI.StandardConfigurator
SimpleOpenAIAnyscale
The Anyscale OpenAI implementation which implements a subset of the standard services.
SimpleOpenAIAnyscale.AnyscaleConfigurator
SimpleOpenAIAzure
The Azure OpenAI implementation which implements a subset of the standard services.
SimpleOpenAIAzure.AzureConfigurator
SimpleOpenAIException
SimpleOpenAIMistral
The Mistral OpenAI provider which implements a subset of the standard services.
SimpleOpenAIMistral.MistralConfigurator
Size
SpeechRequest
StepDetail
StepDetail.MessageCreationStep
StepDetail.MessageCreationStep.MessageCreation
StepDetail.ToolCallsStep
StepDetail.ToolCallsStep.StepToolCall
StepDetail.ToolCallsStep.StepToolCall.CodeInterpreterToolCall
StepDetail.ToolCallsStep.StepToolCall.CodeInterpreterToolCall.CodeInterpreterTool
StepDetail.ToolCallsStep.StepToolCall.CodeInterpreterToolCall.CodeInterpreterTool.Output
StepDetail.ToolCallsStep.StepToolCall.CodeInterpreterToolCall.CodeInterpreterTool.Output.ImageOutput
StepDetail.ToolCallsStep.StepToolCall.CodeInterpreterToolCall.CodeInterpreterTool.Output.ImageOutput.ImageOutputFile
StepDetail.ToolCallsStep.StepToolCall.CodeInterpreterToolCall.CodeInterpreterTool.Output.LogOutput
StepDetail.ToolCallsStep.StepToolCall.CodeInterpreterToolCall.CodeInterpreterTool.OutputType
StepDetail.ToolCallsStep.StepToolCall.FileSearchToolCall
StepDetail.ToolCallsStep.StepToolCall.FileSearchToolCall.FileSearch
StepDetail.ToolCallsStep.StepToolCall.FileSearchToolCall.FileSearch.FileSearchResult
StepDetail.ToolCallsStep.StepToolCall.FileSearchToolCall.FileSearch.FileSearchResult.FileSearchContent
StepDetail.ToolCallsStep.StepToolCall.FunctionToolCall
StepDetail.ToolCallsStep.StepToolCall.FunctionToolCall.FunctionTool
StreamOptions
Thread
ThreadCreateAndRunRequest
ThreadMessage
ThreadMessage.ThreadMessageStatus
ThreadMessageDelta
ThreadMessageDelta.MessageDeltaDetail
ThreadMessageModifyRequest
ThreadMessageRequest
ThreadMessageRole
ThreadModifyRequest
ThreadRequest
ThreadRun
ThreadRun.RequiredAction
ThreadRun.RequiredAction.RequiredActionType
ThreadRun.RequiredAction.SubmitToolOutput
ThreadRun.RunStatus
ThreadRunModifyRequest
ThreadRunRequest
ThreadRunStep
ThreadRunStep.RunStepStatus
ThreadRunStepDelta
ThreadRunStepDelta.RunStepDeltaDetail
ThreadRunStepQuery
ThreadRunSubmitOutputRequest
ThreadRunSubmitOutputRequest.ToolOutput
Tool
Tool.ToolFunctionDef
ToolCall
ToolChoice
ToolChoice.FunctionName
ToolChoiceOption
ToolResource
ToolResource.CodeInterpreter
ToolResource.FileSearch
ToolResourceFull
ToolResourceFull.FileSearch
ToolResourceFull.FileSearch.VectorStore
ToolType
Transcription
Transcription.AudioWord
Transcription.Segment
TranscriptionRequest
TranscriptionRequest.TimestampGranularity
TranslationRequest
TruncationStrategy
TruncationStrategy.TruncationStrategyType
Upload
Upload.UploadStatus
UploadCompleteRequest
UploadPart
UploadPartRequest
UploadRequest
UploadServices
Usage
Usage.CompletionTokensDetails
Usage.PromptTokensDetails
VectorStore
VectorStore.VectorStoreStatus
VectorStoreFile
VectorStoreFileBatch
VectorStoreFileBatchRequest
VectorStoreFileRequest
VectorStoreModifyRequest
VectorStoreRequest
Voice