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
Assistant
AssistantModifyRequest
AssistantRequest
AssistantStreamEvent
AssistantTool
Attachment
Attachment.AttachmentTool
AudioResponseFormat
BaseSimpleOpenAI
The base abstract class that all providers extend.
BaseSimpleOpenAIArgs
Batch
Batch.BatchError
Batch.BatchErrors
Batch.RequestCountsType
BatchRequest
BatchRequest.CompletionWindowType
Chat
Chat.Choice
Chat.Choice.LogprobInfo
Chat.Choice.LogprobInfo.TokenLogprob
Chat.Choice.LogprobInfo.TopLogprob
ChatMessage
ChatMessage.AssistantMessage
ChatMessage.ChatRole
ChatMessage.ResponseMessage
ChatMessage.SystemMessage
ChatMessage.ToolMessage
ChatMessage.UserMessage
ChatRequest
Completion
Completion.Choice
Completion.Choice.LogProbs
CompletionRequest
Constant
ContentPart
ContentPart.ContentPartImage
ContentPart.ContentPartImage.ImageUrl
ContentPart.ContentPartImage.ImageUrl.ImageDetail
ContentPart.ContentPartText
ContentPart.ContentPartType
DeletedObject
Embedding
<
T
>
EmbeddingBase64
EmbeddingFloat
EmbeddingRequest
EmbeddingRequest.EncodingFormat
EndpointType
EventName
ExpiresAfter
ExpiresAfter.Anchor
FileAnnotation
FileAnnotation.AnnotationType
FileAnnotation.FileCitationAnnotation
FileAnnotation.FileCitationAnnotation.FileCitation
FileAnnotation.FilePathAnnotation
FileAnnotation.FilePathAnnotation.FilePath
FileCount
FileRequest
FileRequest.PurposeType
FileResponse
FileStatus
FineTuning
FineTuning.FineTuningError
FineTuningCheckpoint
FineTuningCheckpoint.Metrics
FineTuningEvent
FineTuningRequest
Functional
FunctionCall
FunctionDef
FunctionExecutor
Generic
<
T
>
HyperParams
Image
ImageEditsRequest
ImageRequest
ImageRequest.Quality
ImageRequest.Style
ImageResponseFormat
ImageVariationsRequest
IncompleteDetail
IncompleteDetail.IncompleteDetailReason
Integration
Integration.IntegrationType
Integration.WandbIntegration
JsonSchemaUtil
LastError
LastError.ErrorCode
Model
Moderation
Moderation.ModerationResult
Moderation.ModerationResult.Category
Moderation.ModerationResult.CategoryScore
ModerationRequest
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.
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.
Page
<
T
>
PageRequest
PageRequest.Order
Poller
<
T
>
ResponseFormat
ResponseFormat.ResponseFormatType
RunStepType
SimpleOpenAI
The standard OpenAI implementation which implements the full services.
SimpleOpenAIAnyscale
The Anyscale OpenAI implementation which implements a subset of the standard services.
SimpleOpenAIAzure
The Azure OpenAI implementation which implements a subset of the standard services.
SimpleUncheckedException
Size
SpeechRequest
SpeechRequest.SpeechResponseFormat
SpeechRequest.Voice
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.FunctionToolCall
StepDetail.ToolCallsStep.StepToolCall.FunctionToolCall.FunctionTool
Thread
ThreadCreateAndRunRequest
ThreadMessage
ThreadMessage.ThreadMessageStatus
ThreadMessageContent
ThreadMessageContent.ContentType
ThreadMessageContent.ImageFileContent
ThreadMessageContent.ImageFileContent.ImageFile
ThreadMessageContent.TextContent
ThreadMessageContent.TextContent.TextAnnotation
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
ThreadRunSubmitOutputRequest
ThreadRunSubmitOutputRequest.ToolOutput
Tool
Tool.ToolFunctionDef
ToolCall
ToolChoice
ToolChoice.FunctionName
ToolChoiceOption
ToolResource
ToolResource.CodeInterpreter
ToolResource.FileSearch
ToolResourceFull
ToolResourceFull.CodeInterpreter
ToolResourceFull.FileSearch
ToolResourceFull.FileSearch.VectorStore
ToolType
Transcription
Transcription.AudioWord
Transcription.Segment
TranscriptionRequest
TranscriptionRequest.TimestampGranularity
TranslationRequest
TruncationStrategy
TruncationStrategy.TruncationStrategyType
Usage
VectorStore
VectorStore.VectorStoreStatus
VectorStoreFile
VectorStoreFileBatch
VectorStoreFileBatchRequest
VectorStoreFileRequest
VectorStoreModifyRequest
VectorStoreRequest