Skip to content

Commit 03f7ac4

Browse files
Quantstruct: update changelog and fine-tuning guide for OpenAPI spec change
1 parent d2eaa35 commit 03f7ac4

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed

changelog.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Updates to Admin APIs, Real-time Sessions, and Fine-tuning Request Payloads
2+
3+
1. **New admin API key endpoints**: You can now manage admin-level keys with “GET,” “POST,” “GET by ID,” and “DELETE” calls at `/organization/admin_api_keys`. This makes it easier to create, review, and delete high-permission keys without mixing them up with normal API keys.
4+
2. **New realtime sessions endpoint**: There is now a “POST /realtime/sessions” method for ephemeral token creation. This lets you quickly generate short-lived client tokens to power more dynamic, real-time applications.
5+
Example Payload:
6+
```json
7+
{
8+
"model": "gpt-4o-realtime-preview-2024-12-17",
9+
"modalities": ["audio", "text"],
10+
"instructions": "You are a helpful assistant.",
11+
"voice": "alloy",
12+
"input_audio_format": "pcm16",
13+
"output_audio_format": "pcm16",
14+
"input_audio_transcription": {
15+
"model": "whisper-1"
16+
},
17+
"turn_detection": null,
18+
"tools": [],
19+
"tool_choice": "auto",
20+
"temperature": 0.8,
21+
"max_response_output_tokens": "inf"
22+
}
23+
```
24+
25+
3. **Fine-tuning job creation changed**: the request now requires you to nest fields under “method” with “type” and “hyperparameters” inside. The [finetuning UI](https://platform.openai.com/finetune) remains unchanged
26+
```json
27+
{
28+
"training_file": "file-abc123",
29+
"model": "gpt-4o-mini",
30+
"method": {
31+
"type": "supervised",
32+
"supervised": {
33+
"hyperparameters": {
34+
"n_epochs": 2
35+
}
36+
}
37+
}
38+
}
39+
```
40+
41+
![Fine-tuning Dashboard](images/finetuning-dashboard.png)
42+
Access fine-tuning UI at https://platform.openai.com/finetune

finetuning-guide.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# OpenAI Fine-tuning Guide
2+
3+
## Overview
4+
Fine-tuning lets you customize OpenAI models by training them on your data to improve style, reliability, and task-specific performance.
5+
6+
- Setting specific style, tone, or format
7+
- Improving reliability for desired outputs
8+
- Handling complex prompts and edge cases
9+
- Teaching new skills or tasks
10+
11+
## Currently Available Models
12+
13+
- `gpt-4o-mini` (recommended for most users)
14+
- `gpt-3.5-turbo`
15+
- `babbage-002`
16+
- `davinci-002`
17+
18+
Note: GPT-4 fine-tuning is in experimental access.
19+
20+
## Step-by-Step Guide
21+
22+
### 1. Prepare Dataset
23+
Create a JSONL file with conversation examples:
24+
25+
### 2. Create Fine-tuning Job
26+
Use the OpenAI API to create a fine-tuning job:
27+
28+
### 3. Monitor Job
29+
Use the dashboard to track job status and progress.
30+
31+
### 4. Evaluate Model
32+
33+
### 5. Deploy Model

0 commit comments

Comments
 (0)