Update OpenAI Compatibility Docs with /v1/models (#5151)

* OpenAI Docs

* Update docs/openai.md

Co-authored-by: Jeffrey Morgan <jmorganca@gmail.com>

* Remove newline

---------

Co-authored-by: Jeffrey Morgan <jmorganca@gmail.com>
This commit is contained in:
royjhan 2024-08-01 18:48:44 -04:00 committed by GitHub
parent ff7c9060ec
commit f561eecfb8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -27,6 +27,8 @@ chat_completion = client.chat.completions.create(
], ],
model='llama3', model='llama3',
) )
list_completion = client.models.list()
``` ```
### OpenAI JavaScript library ### OpenAI JavaScript library
@ -45,6 +47,8 @@ const chatCompletion = await openai.chat.completions.create({
messages: [{ role: 'user', content: 'Say this is a test' }], messages: [{ role: 'user', content: 'Say this is a test' }],
model: 'llama3', model: 'llama3',
}) })
const listCompletion = await openai.models.list()
``` ```
### `curl` ### `curl`
@ -66,6 +70,7 @@ curl http://localhost:11434/v1/chat/completions \
] ]
}' }'
curl http://localhost:11434/v1/models
``` ```
## Endpoints ## Endpoints
@ -103,6 +108,13 @@ curl http://localhost:11434/v1/chat/completions \
- [ ] `user` - [ ] `user`
- [ ] `n` - [ ] `n`
### `/v1/models`
#### Notes
- `created` corresponds to when the model was last modified
- `owned_by` corresponds to the ollama username, defaulting to `"library"`
## Models ## Models
Before using a model, pull it locally `ollama pull`: Before using a model, pull it locally `ollama pull`: