Skip to content

Commit 7b82871

Browse files
committed
Update README for 0.1 release, refs #1
1 parent 3688a43 commit 7b82871

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,13 @@
55
[![Tests](https://github.com/simonw/llm-openai-plugin/actions/workflows/test.yml/badge.svg)](https://github.com/simonw/llm-openai-plugin/actions/workflows/test.yml)
66
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/llm-openai-plugin/blob/main/LICENSE)
77

8-
LLM plugin for OpenAI
8+
[LLM](https://llm.datasette.io/) plugin for [OpenAI models](https://platform.openai.com/docs/models).
99

10-
> [!WARNING]
11-
> This is a very early alpha.
10+
This plugin **is a preview**. LLM currently ships with OpenAI models as part of its default collection, implemented using the [Chat Completions API](https://platform.openai.com/docs/guides/responses-vs-chat-completions).
11+
12+
This plugin implements those same models using the new [Responses API](https://platform.openai.com/docs/api-reference/responses).
13+
14+
Currently the only reason to use this plugin over the LLM defaults is to access [o1-pro](https://platform.openai.com/docs/models/o1-pro), which can only be used via the Responses API.
1215

1316
## Installation
1417

@@ -18,7 +21,13 @@ llm install llm-openai-plugin
1821
```
1922
## Usage
2023

21-
Run this to see the models - they start with the `openai/` prefix:
24+
To run a prompt against `o1-pro` do this:
25+
26+
```bash
27+
llm -m openai/o1-pro "Convince me that pelicans are the most noble of birds"
28+
```
29+
30+
Run this to see a full list of models - they start with the `openai/` prefix:
2231

2332
```bash
2433
llm models -q openai/

0 commit comments

Comments
 (0)