Re-exports§
pub use finish_reason::*;pub use enum_types::*;
Modules§
Structs§
- AddUpload
Part Request - on openapi.yaml:
- Admin
ApiKey - on openapi.yaml
- Admin
ApiKey Owner - on openapi.yaml
- ApiKey
List - on openapi.yaml
- Approximate
Location - on openapi.yaml
- Assistant
Object - on openapi.yaml
- Assistant
Object Tool Resources - Assistant
Object Tool Resources Code Interpreter - Assistant
Object Tool Resources File Search - Assistant
Tools Code - on openapi.yaml
- Assistant
Tools File Search - on openapi.yaml
- Assistant
Tools File Search File Search - Assistant
Tools File Search Type Only - on openapi.yaml
- Assistant
Tools Function - on openapi.yaml
- Assistants
Named Tool Choice - Assistants
Named Tool Choice Function - Audit
Log - Audit
LogActor - on openapi.yaml
- Audit
LogActor ApiKey - on openapi.yaml
- Audit
LogActor Service Account - on openapi.yaml
- Audit
LogActor Session - on openapi.yaml
- Audit
LogActor User - on openapi.yaml
- Audit
LogApi KeyCreated - Audit
LogApi KeyCreated Data - Audit
LogApi KeyDeleted - Audit
LogApi KeyUpdated - Audit
LogApi KeyUpdated Changes Requested - Audit
LogCertificate Created - Audit
LogCertificate Deleted - Audit
LogCertificates Activated - Audit
LogCertificates Activated Certificates - Audit
LogCheckpoint Permission Created - Audit
LogCheckpoint Permission Created Data - Audit
LogCheckpoint Permission Deleted - Audit
LogInvite Accepted - Audit
LogInvite Sent - Audit
LogInvite Sent Data - Audit
LogLogin Failed - Audit
LogOrganization Updated - Audit
LogOrganization Updated Changes Requested - Audit
LogOrganization Updated Changes Requested Settings - Audit
LogProject - Audit
LogProject Archived - Audit
LogProject Created - Audit
LogProject Created Data - Audit
LogProject Updated - Audit
LogProject Updated Changes Requested - Audit
LogRate Limit Deleted - Audit
LogRate Limit Updated - Audit
LogRate Limit Updated Changes Requested - Audit
LogService Account Created - Audit
LogService Account Created Data - Audit
LogService Account Deleted - Audit
LogService Account Updated - Audit
LogService Account Updated Changes Requested - Audit
LogUser Added - Audit
LogUser Added Data - Audit
LogUser Deleted - Audit
LogUser Updated - Audit
LogUser Updated Changes Requested - Auto
Chunking Strategy Request Param - on openapi.yaml
- Batch
- .
- Batch
Errors - Batch
Errors Data - Batch
Request Counts - Batch
Request Input - on openapi.yaml
- Batch
Request Output - on openapi.yaml
- Batch
Request Output Error - Batch
Request Output Response - Body
- Body1
- Body2
- Body3
- Certificate
- on openapi.yaml
- Certificate
Certificate Details - Chat
Completion Deleted - Chat
Completion Function Call Option - Chat
Completion Functions - Chat
Completion List - Chat
Completion Message List - Chat
Completion Message List Id - Chat
Completion Message Tool Call - Chat
Completion Message Tool Call Chunk - on openapi.yaml
- Chat
Completion Message Tool Call Chunk Function - Chat
Completion Message Tool Call Function - Chat
Completion Message Tool Calls - on openapi.yaml
- Chat
Completion Modalities - on openapi.yaml
- Chat
Completion Named Tool Choice - Chat
Completion Request Assistant Message - Chat
Completion Request Assistant Message Audio - Chat
Completion Request Assistant Message Function Call - Chat
Completion Request Developer Message - Chat
Completion Request Function Message - on openapi.yaml
- Chat
Completion Request Message Content Part Audio - Chat
Completion Request Message Content Part Audio Input Audio - Chat
Completion Request Message Content Part File - Chat
Completion Request Message Content Part File File - Chat
Completion Request Message Content Part Image - Chat
Completion Request Message Content Part Image Image Url - Chat
Completion Request Message Content Part Refusal - on openapi.yaml
- Chat
Completion Request Message Content Part Text - on openapi.yaml
- Chat
Completion Request System Message - on openapi.yaml
- Chat
Completion Request Tool Message - on openapi.yaml
- Chat
Completion Request User Message - on openapi.yaml
- Chat
Completion Response Message - Chat
Completion Response Message Annotations - Chat
Completion Response Message Audio - Chat
Completion Response Message Function Call - Chat
Completion Response Message UrlCitation - Chat
Completion Stream Options - on openapi.yaml
- Chat
Completion Stream Response Delta - on openapi.yaml
- Chat
Completion Stream Response Delta Function Call - Chat
Completion Token Logprob - on openapi.yaml
- Chat
Completion Token Logprob TopLogprobs - Chat
Completion Tool - on openapi.yaml
- Click
- on openapi.yaml
- Code
Interpreter File Output - on openapi.yaml
- Code
Interpreter File Output Files - Code
Interpreter Text Output - on openapi.yaml
- Code
Interpreter Tool Call - on openapi.yaml
- Comparison
Filter - Complete
Upload Request - on openapi.yaml
- Completion
Usage - Completion
Usage Completion Tokens Details - Completion
Usage Prompt Tokens Details - Compound
Filter - on openapi.yaml
- Computer
Call Output Item Param - on openapi.yaml
- Computer
Call Safety Check Param - on openapi.yaml
- Computer
Screenshot Image - on openapi.yaml
- Computer
Tool Call - on openapi.yaml
- Computer
Tool Call Output - on openapi.yaml
- Computer
Tool Call Output Resource - on openapi.yaml
- Computer
Tool Call Safety Check - on openapi.yaml
- Computer
UsePreview Tool - on openapi.yaml
- Coordinate
- on openapi.yaml
- Costs
Result - on openapi.yaml
- Costs
Result Amount - Create
Assistant Request - Create
Assistant Request Tool Resources - Create
Assistant Request Tool Resources Code Interpreter - Create
Assistant Request Tool Resources File Search - Create
Assistant Request Tool Resources File Search Vector Stores - Create
Chat Completion Request - Create
Chat Completion Request Audio - Create
Chat Completion Response - todo: 过长之后看
- Create
Chat Completion Response Choices - Create
Chat Completion Response Logprobs - Create
Chat Completion Stream Response - Create
Chat Completion Stream Response Choices - Create
Completion Request - Create
Completion Response - todo: 长，改天看
- Create
Completion Response Choices - Create
Completion Response Logprobs - Create
Embedding Request - on openapi.yaml
- Create
Embedding Response - on openapi.yaml
- Create
Embedding Response Usage - Create
Eval Completions RunData Source - Create
Eval Completions RunData Source Sampling Params - Create
Eval Jsonl RunData Source - on openapi.yaml
- Create
Eval Label Model Grader - Create
Eval Request - Create
Eval Responses RunData Source - Create
Eval RunRequest - on openapi.yaml
- Create
File Request - on openapi.yaml
- Create
Fine Tuning Checkpoint Permission Request - on openapi.yaml
- Create
Fine Tuning JobRequest - Create
Fine Tuning JobRequest Hyperparameters - Create
Fine Tuning JobRequest Integrations - Create
Fine Tuning JobRequest Wandb - Create
Image Edit Request - Create
Image Request - Create
Image Variation Request - Create
Message Request - Create
Message Request Attachments - Create
Model Response Properties - Create
Moderation Request - Create
Moderation Response - Create
Moderation Response Categories - Create
Moderation Response Category Applied Input Types - Create
Moderation Response Category Scores - Create
Moderation Response Results - Create
Response - Create
RunRequest - Create
RunRequest Tool Choice - Create
Speech Request - Create
Thread AndRun Request - Create
Thread AndRun Request Tool Resources - Create
Thread Request - Create
Thread Request Tool Resources - Create
Thread Request Tool Resources File Search - Create
Transcription Request - Create
Transcription Response Json - Create
Transcription Response Json Logprobs - Create
Transcription Response Verbose Json - Create
Translation Request - Create
Translation Response Json - Create
Translation Response Verbose Json - Create
Upload Request - Create
Vector Store File Batch Request - Create
Vector Store File Request - Create
Vector Store Request - Delete
Assistant Response - Delete
Certificate Response - Delete
File Response - Delete
Fine Tuning Checkpoint Permission Response - Delete
Message Response - Delete
Model Response - Delete
Thread Response - Delete
Vector Store File Response - Delete
Vector Store Response - Done
Event - on openapi.yaml
- Double
Click - Drag
- Easy
Input Message - Embedding
- Error
- Error
Event - on openapi.yaml
- Error
Response - Eval
- Eval
ApiError - Eval
Item - Eval
Jsonl File IdSource - Eval
Label Model Grader - Eval
List - Eval
Python Grader - Eval
Responses Source - EvalRun
- Eval
RunList - Eval
RunOutput Item Sample - Eval
RunOutput Item Sample Input - Eval
RunOutput Item Sample Output - Eval
RunOutput Item Sample Usage - Eval
RunPer Model Usage - Eval
RunPer Testing Criteria Results - Eval
RunResult Counts - Eval
Score Model Grader - Eval
Stored Completions Source - Eval
String Check Grader - Eval
Text Similarity Grader - File
- File
Citation Body - File
Path - File
Search Ranking Options - File
Search Tool - File
Search Tool Call - File
Search Tool Call Results - Fine
Tune Chat Completion Request Assistant Message - Fine
Tune Chat Request Input - Fine
Tune Completion Request Input - Fine
Tune DpoMethod - Fine
Tune DpoMethod Hyperparameters - Fine
Tune Method - Fine
Tune Preference Request Input - Fine
Tune Preference Request Input Input - Fine
Tune Supervised Method - Fine
Tune Supervised Method Hyperparameters - Fine
Tuning Checkpoint Permission - Fine
Tuning Integration - Fine
Tuning Job - Fine
Tuning JobCheckpoint - Fine
Tuning JobCheckpoint Metrics - Fine
Tuning JobError - Fine
Tuning JobEvent - Fine
Tuning JobHyperparameters - Function
Call Output Item Param - Function
Object - on openapi.yaml
- Function
Tool - Function
Tool Call - Function
Tool Call Output - Function
Tool Call Output Resource - Function
Tool Call Resource - Image
- Images
Response - Images
Response Usage - Images
Response Usage Input Tokens Details - Includable
- Inline
Response200 - Inline
Response2001 - Inline
Response2002 - Input
Audio - Input
File Content - Input
Image Content - Input
Item - Input
Message - Input
Message Content List - Input
Message Resource - Input
Text Content - Invite
- Invite
Delete Response - Invite
List Response - Invite
Projects - Invite
Request - Invite
Request Projects - Item
- Item
Object - on openapi.yaml
- Item
Reference Param - Item
Resource - Json
Schema - KeyPress
- List
Assistants Response - List
Audit Logs Response - List
Batches Response - List
Certificates Response - List
Files Response - List
Fine Tuning Checkpoint Permission Response - List
Fine Tuning JobCheckpoints Response - List
Fine Tuning JobEvents Response - List
Messages Response - List
Models Response - List
Paginated Fine Tuning Jobs Response - List
RunSteps Response - List
Runs Response - List
Vector Store Files Response - List
Vector Stores Response - LogProb
Properties - Message
Content Image File Object - Message
Content Image File Object Image File - Message
Content Image UrlObject - Message
Content Image UrlObject Image Url - Message
Content Refusal Object - Message
Content Text Annotations File Citation Object - Message
Content Text Annotations File Citation Object File Citation - Message
Content Text Annotations File Path Object - Message
Content Text Annotations File Path Object File Path - Message
Content Text Object - Message
Content Text Object Text - Message
Delta Content Image File Object - Message
Delta Content Image File Object Image File - Message
Delta Content Image UrlObject - Message
Delta Content Image UrlObject Image Url - Message
Delta Content Refusal Object - Message
Delta Content Text Annotations File Citation Object - Message
Delta Content Text Annotations File Citation Object File Citation - Message
Delta Content Text Annotations File Path Object - Message
Delta Content Text Annotations File Path Object File Path - Message
Delta Content Text Object - Message
Delta Content Text Object Text - Message
Delta Object - Message
Delta Object Delta - Message
Object - Message
Object Incomplete Details - Message
Request Content Text Object - Message
Stream Event - on openapi.yaml
- Metadata
- on openapi.yaml
- Model
- Model
Ids - Model
IdsResponses - Model
Move - Model
Response Properties - Model
Type - Modify
Assistant Request - Modify
Assistant Request Tool Resources - Modify
Assistant Request Tool Resources Code Interpreter - Modify
Assistant Request Tool Resources File Search - Modify
Certificate Request - Modify
Message Request - Modify
RunRequest - Modify
Thread Request - Modify
Thread Request Tool Resources - Modify
Thread Request Tool Resources File Search - Open
AiFile - Other
Chunking Strategy Response Param - Output
Audio - Output
Item - Output
Message - Output
Text Content - Prediction
Content - on openapi.yaml
- Project
- Project
ApiKey - Project
ApiKey Delete Response - Project
ApiKey List Response - Project
ApiKey Owner - Project
Create Request - Project
List Response - Project
Rate Limit - Project
Rate Limit List Response - Project
Rate Limit Update Request - Project
Service Account - Project
Service Account ApiKey - Project
Service Account Create Request - Project
Service Account Create Response - Project
Service Account Delete Response - Project
Service Account List Response - Project
Update Request - Project
User - Project
User Create Request - Project
User Delete Response - Project
User List Response - Project
User Update Request - Ranking
Options - Realtime
Client Event - Realtime
Client Event Conversation Item Create - Realtime
Client Event Conversation Item Delete - Realtime
Client Event Conversation Item Retrieve - Realtime
Client Event Conversation Item Truncate - Realtime
Client Event Input Audio Buffer Append - Realtime
Client Event Input Audio Buffer Clear - Realtime
Client Event Input Audio Buffer Commit - Realtime
Client Event Output Audio Buffer Clear - Realtime
Client Event Response Cancel - Realtime
Client Event Response Create - Realtime
Client Event Session Update - Realtime
Client Event Transcription Session Update - Realtime
Conversation Item - Realtime
Conversation Item Content - Realtime
Conversation Item With Reference - Realtime
Response - Realtime
Response Create Params - Realtime
Response Create Params Tools - Realtime
Response Status Details - Realtime
Response Status Details Error - Realtime
Response Usage - Realtime
Response Usage Input Token Details - Realtime
Response Usage Output Token Details - Realtime
Server Event - Realtime
Server Event Conversation Created - Realtime
Server Event Conversation Created Conversation - Realtime
Server Event Conversation Item Created - Realtime
Server Event Conversation Item Deleted - Realtime
Server Event Conversation Item Input Audio Transcription Completed - Realtime
Server Event Conversation Item Input Audio Transcription Delta - Realtime
Server Event Conversation Item Input Audio Transcription Failed - Realtime
Server Event Conversation Item Input Audio Transcription Failed Error - Realtime
Server Event Conversation Item Retrieved - Realtime
Server Event Conversation Item Truncated - Realtime
Server Event Error - Realtime
Server Event Error Error - Realtime
Server Event Input Audio Buffer Cleared - Realtime
Server Event Input Audio Buffer Committed - Realtime
Server Event Input Audio Buffer Speech Started - Realtime
Server Event Input Audio Buffer Speech Stopped - Realtime
Server Event Output Audio Buffer Cleared - Realtime
Server Event Output Audio Buffer Started - Realtime
Server Event Output Audio Buffer Stopped - Realtime
Server Event Rate Limits Updated - Realtime
Server Event Rate Limits Updated Rate Limits - Realtime
Server Event Response Audio Delta - Realtime
Server Event Response Audio Done - Realtime
Server Event Response Audio Transcript Delta - Realtime
Server Event Response Audio Transcript Done - Realtime
Server Event Response Content Part Added - Realtime
Server Event Response Content Part Added Part - Realtime
Server Event Response Content Part Done - Realtime
Server Event Response Content Part Done Part - Realtime
Server Event Response Created - Realtime
Server Event Response Done - Realtime
Server Event Response Function Call Arguments Delta - Realtime
Server Event Response Function Call Arguments Done - Realtime
Server Event Response Output Item Added - Realtime
Server Event Response Output Item Done - Realtime
Server Event Response Text Delta - Realtime
Server Event Response Text Done - Realtime
Server Event Session Created - Realtime
Server Event Session Updated - Realtime
Server Event Transcription Session Updated - Realtime
Session - Realtime
Session Create Request - Realtime
Session Create Response - Realtime
Session Create Response Client Secret - Realtime
Session Create Response Input Audio Transcription - Realtime
Session Create Response Turn Detection - Realtime
Session Input Audio Noise Reduction - Realtime
Session Input Audio Transcription - Realtime
Session Turn Detection - Realtime
Transcription Session Create Request - Realtime
Transcription Session Create Request Input Audio Transcription - Realtime
Transcription Session Create Request Turn Detection - Realtime
Transcription Session Create Response - Realtime
Transcription Session Create Response Client Secret - Realtime
Transcription Session Create Response Input Audio Transcription - Reasoning
- Reasoning
Item - Reasoning
Item Summary - Refusal
Content - Response
- Response
Audio Delta Event - Response
Audio Done Event - Response
Audio Transcript Delta Event - Response
Audio Transcript Done Event - Response
Code Interpreter Call Code Delta Event - Response
Code Interpreter Call Code Done Event - Response
Code Interpreter Call Completed Event - Response
Code Interpreter Call InProgress Event - Response
Code Interpreter Call Interpreting Event - Response
Completed Event - Response
Content Part Added Event - Response
Content Part Done Event - Response
Created Event - Response
Error - Response
Error Code - Response
Error Event - Response
Failed Event - Response
File Search Call Completed Event - Response
File Search Call InProgress Event - Response
File Search Call Searching Event - Response
Format Json Schema - on openapi.yaml
- Response
Function Call Arguments Delta Event - Response
Function Call Arguments Done Event - Response
InProgress Event - Response
Incomplete Details - Response
Incomplete Event - Response
Item List - Response
Output Item Added Event - Response
Output Item Done Event - Response
Properties - Response
Properties Text - Response
Reasoning Summary Part Added Event - Response
Reasoning Summary Part Added Event Part - Response
Reasoning Summary Part Done Event - Response
Reasoning Summary Part Done Event Part - Response
Reasoning Summary Text Delta Event - Response
Reasoning Summary Text Done Event - Response
Refusal Delta Event - Response
Refusal Done Event - Response
Stream Event - Response
Text Annotation Delta Event - Response
Text Delta Event - Response
Text Done Event - Response
Usage - Response
Usage Input Tokens Details - Response
Usage Output Tokens Details - Response
WebSearch Call Completed Event - Response
WebSearch Call InProgress Event - Response
WebSearch Call Searching Event - RunCompletion
Usage - RunObject
- RunObject
Incomplete Details - RunObject
Last Error - RunObject
Required Action - RunObject
Required Action Submit Tool Outputs - RunStep
Completion Usage - RunStep
Delta Object - RunStep
Delta Object Delta - RunStep
Delta Step Details Message Creation Object - RunStep
Delta Step Details Message Creation Object Message Creation - RunStep
Delta Step Details Tool Calls Code Object - RunStep
Delta Step Details Tool Calls Code Object Code Interpreter - RunStep
Delta Step Details Tool Calls Code Output Image Object - RunStep
Delta Step Details Tool Calls Code Output Image Object Image - RunStep
Delta Step Details Tool Calls Code Output Logs Object - RunStep
Delta Step Details Tool Calls File Search Object - RunStep
Delta Step Details Tool Calls Function Object - RunStep
Delta Step Details Tool Calls Function Object Function - RunStep
Delta Step Details Tool Calls Object - RunStep
Details Message Creation Object - RunStep
Details Message Creation Object Message Creation - RunStep
Details Tool Calls Code Object - RunStep
Details Tool Calls Code Object Code Interpreter - RunStep
Details Tool Calls Code Output Image Object - RunStep
Details Tool Calls Code Output Image Object Image - RunStep
Details Tool Calls Code Output Logs Object - RunStep
Details Tool Calls File Search Object - RunStep
Details Tool Calls File Search Object File Search - RunStep
Details Tool Calls File Search Ranking Options Object - RunStep
Details Tool Calls File Search Result Object - RunStep
Details Tool Calls File Search Result Object Content - RunStep
Details Tool Calls Function Object - RunStep
Details Tool Calls Function Object Function - RunStep
Details Tool Calls Object - RunStep
Object - RunStep
Object Last Error - RunStep
Stream Event - on openapi.yaml
- RunStream
Event - on openapi.yaml
- RunTool
Call Object - RunTool
Call Object Function - Screenshot
- Scroll
- Static
Chunking Strategy - Static
Chunking Strategy Request Param - Static
Chunking Strategy Response Param - Submit
Tool Outputs RunRequest - Submit
Tool Outputs RunRequest Tool Outputs - Text
Response Format Configuration - Text
Response Format Json Schema - Thread
Object - Thread
Stream Event - on openapi.yaml
- Toggle
Certificates Request - Tool
- Tool
Choice Function - Tool
Choice Options - Tool
Choice Types - Transcription
Include - Transcription
Segment - Transcription
Word - Truncation
Object - Update
Vector Store File Attributes Request - Update
Vector Store Request - Upload
- Upload
Certificate Request - Upload
Part - UrlCitation
Body - Usage
Audio Speeches Result - Usage
Audio Transcriptions Result - Usage
Code Interpreter Sessions Result - Usage
Completions Result - Usage
Embeddings Result - Usage
Images Result - Usage
Moderations Result - Usage
Response - Usage
Time Bucket - Usage
Vector Stores Result - User
- User
Delete Response - User
List Response - User
Role Update Request - Vector
Store Expiration After - Vector
Store File Attributes - Vector
Store File Batch Object - Vector
Store File Batch Object File Counts - Vector
Store File Content Response - Vector
Store File Content Response Data - Vector
Store File Object - Vector
Store File Object Last Error - Vector
Store Object - Vector
Store Object File Counts - Vector
Store Search Result Content Object - Vector
Store Search Result Item - Vector
Store Search Results Page - Wait
- WebSearch
- WebSearch
Location - WebSearch
Preview Tool - WebSearch
Tool Call - WebSearch
User Location
Enums§
- Annotation
- on openapi.yaml
- Assistant
Object Tool - Assistant
Stream Event - on openapi.yaml
- Assistant
Supported Models - on openapi.yaml
- Assistants
ApiResponse Format Option - on openapi.yaml
- Assistants
ApiTool Choice Option - on openapi.yaml
- Audio
Response Format - on openapi.yaml
- Audit
LogEvent Type - on openapi.yaml
- Chat
Completion Message List Data - Chat
Completion Modality - Chat
Completion Request Assistant Message Content - Chat
Completion Request Assistant Message Content Part - on openapi.yaml
- Chat
Completion Request Developer Message Content - Chat
Completion Request Message - Chat
Completion Request System Message Content - Chat
Completion Request System Message Content Part - on openapi.yaml
- Chat
Completion Request Tool Message Content - on openapi.yaml
- Chat
Completion Request Tool Message Content Part - on openapi.yaml
- Chat
Completion Request User Message Content - Chat
Completion Request User Message Content Part - on openapi.yaml
- Chat
Completion Role - on openapi.yaml
- Chat
Completion Tool Choice Option - on openapi.yaml
- Chat
Completion Tool Choice StrEnum - Chunking
Strategy Request Param - on openapi.yaml
- Code
Interpreter Tool Output - on openapi.yaml
- Comparison
Filter Value - Compound
Filter Item - Computer
Action - on openapi.yaml
- Content
- on openapi.yaml
- Create
Assistant Request Tool - Create
Chat Completion Request Function Call - Create
Chat Completion Request Response Format - Create
Embedding Request Input - Create
Eval Item - on openapi.yaml
- Create
Message Request Attachments Tool - Create
Transcription Response Stream Event - on openapi.yaml
- File
Search Ranker - on openapi.yaml
- Filters
- on openapi.yaml
- Input
Content - on openapi.yaml
- Message
Content Text Object Text Annotations - Output
Content - on openapi.yaml
- Prediction
Content Content - on openai.yaml
- Reasoning
Effort - on openapi.yaml
- Response
Format Text - on openapi.yaml
- Response
Modalities Item - RunStep
Delta Step Details Tool Calls Code Object Code Interpreter Output - Service
Tier - Stop
Configuration - on openai.yaml
- Voice
IdsShared - WebSearch
Context Size - on openai.yaml
Type Aliases§
- Function
Parameters - on openapi.yaml
- Model
IdsShared - on openapi.yaml
- Parallel
Tool Calls - on openai.yaml
- Response
Format Json Object - on openapi.yaml
- Response
Format Json Schema Schema - on openapi.yaml
- Response
Modalities - on openapi.yaml