baalajimaestro/ollama
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update docs with chat completion api

Browse source
This commit is contained in:
Jeffrey Morgan 2023-12-10 13:53:36 -05:00
parent 7db5bcf73b
commit 5d4d2e2c60
2 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -205,7 +205,8 @@ Finally, in a separate shell, run a model:
## REST API ## REST API
Ollama has a REST API for running and managing models. Ollama has a REST API for running and managing models.
For example, to generate text from a model:
### Generate a response
``` ```
curl http://localhost:11434/api/generate -d '{ curl http://localhost:11434/api/generate -d '{
@ -214,7 +215,7 @@ curl http://localhost:11434/api/generate -d '{
}' }'
``` ```
Or send a chat message (coming in 0.1.14): ### Chat with a model
``` ```
curl http://localhost:11434/api/chat -d '{ curl http://localhost:11434/api/chat -d '{

3
docs/api.md
View file

@ -3,6 +3,7 @@
## Endpoints ## Endpoints
- [Generate a completion](#generate-a-completion) - [Generate a completion](#generate-a-completion)
- [Generate a chat completion](#generate-a-chat-completion)
- [Create a Model](#create-a-model) - [Create a Model](#create-a-model)
- [List Local Models](#list-local-models) - [List Local Models](#list-local-models)
- [Show Model Information](#show-model-information) - [Show Model Information](#show-model-information)
@ -290,7 +291,7 @@ curl http://localhost:11434/api/generate -d '{
} }
``` ```
## Send Chat Messages (coming in 0.1.14) ## Generate a chat completion
```shell ```shell
POST /api/chat POST /api/chat