toggle menu
openai-kotlin
common
switch theme
openai-client
com.
aallam.
openai.
client
Assistants
Audio
Batch
Chat
Completions
Edits
Embeddings
Files
Fine
Tunes
Fine
Tuning
Images
Logging
Config
Messages
Models
Moderations
Open
AI
Open
AI()
Open
AIConfig
Open
AIHost
Companion
Proxy
Config
Http
Socks
Retry
Strategy
Runs
Threads
Vector
Stores
com.
aallam.
openai.
client.
extension
distance()
get
Data()
merge
To
Chat
Message()
similarity()
openai-core
com.
aallam.
openai.
api
Beta
Open
AI
Experimental
Open
AI
Internal
Open
AI
Open
AIDsl
com.
aallam.
openai.
api.
assistant
Assistant
Assistant
Id
Assistant
Request
assistant
Request()
Assistant
Request
Builder
Assistant
Response
Format
Companion
Json
Schema
Response
Format
Serializer
Assistant
Tool
Code
Interpreter
File
Search
Function
Tool
build
Json
Object()
Code
Interpreter
Resources
File
Search
Resources
Function
function()
Function
Builder
Tool
Resources
com.
aallam.
openai.
api.
audio
Audio
Response
Format
Companion
Segment
Speech
Request
speech
Request()
Speech
Request
Builder
Speech
Response
Format
Companion
Timestamp
Granularity
Companion
Transcription
Transcription
Request
transcription
Request()
Transcription
Request
Builder
Translation
Translation
Request
translation
Request()
Translation
Request
Builder
Voice
Companion
Word
com.
aallam.
openai.
api.
batch
Batch
Batch
Id
Batch
Request
batch
Request()
Batch
Request
Builder
Completion
Window
Companion
Custom
Id
Method
Companion
Request
Counts
Request
Input
Request
Output
Response
Output
com.
aallam.
openai.
api.
chat
assistant
Message()
Assistant
Message
Builder
Chat
Choice
Chat
Chunk
Chat
Completion
Chat
Completion
Chunk
Chat
Completion
Function
chat
Completion
Function()
Chat
Completion
Function
Builder
Chat
Completion
Request
chat
Completion
Request()
Chat
Completion
Request
Builder
Chat
Delta
Chat
Message
Companion
chat
Message()
Chat
Message
Builder
Chat
Messages
Builder
Chat
Response
Format
Companion
Chat
Role
Content
Content
Filter
Offsets
Content
Filter
Result
Content
Filter
Results
Content
Part
Content
Part
Builder
Effort
function()
Function
Call
Function
Mode
Companion
Default
Named
Functions
Builder
Function
Tool
Function
Tool
Call
Builder
Function
Tool
Choice
Image
Part
Image
URL
Json
Schema
List
Content
Logprobs
Logprobs
Content
Parameters
Stream
Options
stream
Options()
Stream
Options
Builder
system
Message()
System
Message
Builder
Text
Content
Text
Part
Tool
Companion
Tool
Builder
Tool
Call
Function
Tool
Call
Chunk
Tool
Calls
Builder
Tool
Choice
Companion
Mode
Named
Tool
Id
tool
Message()
Tool
Message
Builder
Tool
Type
Companion
Top
Logprob
user
Message()
User
Message
Builder
com.
aallam.
openai.
api.
completion
Choice
Completion
Request
completion
Request()
Completion
Request
Builder
Logprobs
Text
Completion
com.
aallam.
openai.
api.
core
Delete
Response
Endpoint
Companion
Finish
Reason
Companion
Last
Error
List
Response
Organization
Id
Paginated
List
Parameters
Companion
Json
Data
Serializer
Request
Id
Request
Options
Role
Companion
Sort
Order
Companion
Status
Companion
Usage
com.
aallam.
openai.
api.
edits
Edit
Edits
Request
edits
Request()
Edits
Request
Builder
com.
aallam.
openai.
api.
embedding
Embedding
Embedding
Request
embedding
Request()
Embedding
Request
Builder
Embedding
Response
com.
aallam.
openai.
api.
exception
Authentication
Exception
Generic
IOException
Invalid
Request
Exception
Open
AIAPIException
Open
AIError
Open
AIError
Details
Open
AIException
Open
AIHttp
Exception
Open
AIIOException
Open
AIServer
Exception
Open
AITimeout
Exception
Permission
Exception
Rate
Limit
Exception
Unknown
APIException
com.
aallam.
openai.
api.
file
File
File
Id
File
Source
file
Source()
File
Source
Builder
File
Status
File
Upload
file
Upload()
File
Upload
Builder
Purpose
com.
aallam.
openai.
api.
finetune
Fine
Tune
Fine
Tune
Event
Fine
Tune
Id
Fine
Tune
Request
fine
Tune
Request()
Fine
Tune
Request
Builder
Hyper
Params
com.
aallam.
openai.
api.
finetuning
Error
Info
Fine
Tuning
Id
Fine
Tuning
Job
Fine
Tuning
Job
Event
Fine
Tuning
Request
fine
Tuning
Request()
Fine
Tuning
Request
Builder
Hyperparameters
NEpochs
Companion
Level
Companion
com.
aallam.
openai.
api.
http
Timeout
com.
aallam.
openai.
api.
image
Image
Creation
image
Creation()
Image
Creation
Builder
Image
Edit
image
Edit()
Image
Edit
Builder
Image
JSON
Image
Size
Companion
Image
URL
Image
Variation
image
Variation()
Image
Variation
Builder
Quality
Companion
Style
Companion
com.
aallam.
openai.
api.
image.
internal
Image
Creation
Request
Image
Response
Format
Companion
com.
aallam.
openai.
api.
logging
Logger
Default
Simple
Empty
Log
Level
All
Headers
Body
Info
None
com.
aallam.
openai.
api.
message
Attachment
attachment()
Attachment
Builder
File
Citation
File
Citation
Annotation
File
Path
File
Path
Annotation
Image
File
Message
Message
Content
Image
Text
Message
Id
Message
Request
message
Request()
Message
Request
Builder
Text
Annotation
Text
Content
com.
aallam.
openai.
api.
model
Model
Model
Id
Model
Permission
com.
aallam.
openai.
api.
moderation
Categories
Category
Scores
Moderation
Model
Companion
Moderation
Request
moderation
Request()
Moderation
Request
Builder
Moderation
Result
Text
Moderation
com.
aallam.
openai.
api.
run
Assistant
Stream
Event
Assistant
Stream
Event
Type
Companion
THREAD_CREATED
THREAD_RUN_CREATED
THREAD_RUN_QUEUED
THREAD_RUN_IN_PROGRESS
THREAD_RUN_REQUIRES_ACTION
THREAD_RUN_COMPLETED
THREAD_RUN_INCOMPLETE
THREAD_RUN_FAILED
THREAD_RUN_CANCELLING
THREAD_RUN_CANCELLED
THREAD_RUN_EXPIRED
THREAD_RUN_STEP_CREATED
THREAD_RUN_STEP_IN_PROGRESS
THREAD_RUN_STEP_DELTA
THREAD_RUN_STEP_COMPLETED
THREAD_RUN_STEP_FAILED
THREAD_RUN_STEP_CANCELLED
THREAD_RUN_STEP_EXPIRED
THREAD_MESSAGE_CREATED
THREAD_MESSAGE_IN_PROGRESS
THREAD_MESSAGE_DELTA
THREAD_MESSAGE_COMPLETED
THREAD_MESSAGE_INCOMPLETE
ERROR
DONE
UNKNOWN
Assistant
Stream
Event
Type
Serializer
Code
Interpreter
Image
Code
Interpreter
Tool
Call
Code
Interpreter
Tool
Call
Output
Image
Logs
File
Search
Tool
Call
Ranking
Options
File
Search
Tool
Call
Result
File
Search
Tool
Call
Step
Function
Tool
Call
Step
Message
Creation
Message
Creation
Step
Message
Creation
Step
Details
Message
Delta
Message
Delta
Data
Required
Action
Submit
Tool
Outputs
Run
Run
Id
Run
Request
run
Request()
Run
Request
Builder
Run
Step
Run
Step
Delta
Run
Step
Delta
Data
Run
Step
Details
Run
Step
Id
Thread
Run
Request
thread
Run
Request()
Thread
Run
Request
Builder
Tool
Calls
Step
Tool
Call
Step
Code
Interpreter
File
Search
Tool
Function
Tool
Retrieval
Tool
Tool
Call
Step
Details
Tool
Call
Step
Id
Tool
Output
tool
Output()
Tool
Output
Builder
Tool
Outputs
com.
aallam.
openai.
api.
thread
Thread
Thread
Id
Thread
Message
thread
Message()
Thread
Message
Builder
Thread
Messages
Builder
Thread
Request
thread
Request()
Thread
Request
Builder
com.
aallam.
openai.
api.
vectorstore
Expiration
Policy
File
Batch
Request
File
Counts
Files
Batch
Vector
Store
Vector
Store
File
Vector
Store
File
Request
Vector
Store
Id
Vector
Store
Request
openai-core
/
com.aallam.openai.api.chat
/
ChatResponseFormat
/
jsonSchema
json
Schema
@
SerialName
(
value
=
"json_schema"
)
val
jsonSchema
:
JsonSchema
?
=
null
Optional JSON schema specification when type is "json_schema"