aboutsummaryrefslogtreecommitdiffstats
path: root/packages/multillm-openai/README.md
blob: a5c5d00ca2a971d6cdddc80d96c32aca8bd7db86 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# multillm-openai

OpenAI provider for [multillm](../multillm).

## Installation

```bash
pip install multillm-openai
```

## Usage

```python
import asyncio
import multillm

async def main():
    client = multillm.Client()

    # Simple query
    answer = await client.single("openai/gpt-4o", "Hello!")
    print(answer)

    # Chat completion
    response = await client.chat_complete("openai/gpt-4o", [
        {"role": "user", "content": "What is Python?"}
    ])
    print(response.text)

    # Streaming
    async for chunk in client.chat_complete_stream("openai/gpt-4o", messages):
        print(chunk, end="")

asyncio.run(main())
```

## Configuration

Choose one of the following methods (priority: direct config > env var > config file):

**Option 1: Config file** (recommended)

Create `~/.config/multillm/providers/openai.json`:

```json
{
  "api_key": "sk-...",
  "organization": "org-..."
}
```

Set permissions:
```bash
chmod 600 ~/.config/multillm/providers/openai.json
```

**Option 2: Environment variable**

```bash
export OPENAI_API_KEY=sk-...
```

**Option 3: Direct config**

```python
client = multillm.Client({
    "openai": {"api_key": "sk-...", "organization": "org-..."}
})
```

### Config File Fields

| Field | Required | Description |
|-------|----------|-------------|
| `api_key` | Yes | Your OpenAI API key |
| `organization` | No | Your organization ID (if applicable) |

## Models

Use OpenAI model names after the provider prefix:

- `openai/gpt-4o`
- `openai/gpt-4o-mini`
- `openai/gpt-4-turbo`
- `openai/o1-preview`