update api docs
This commit is contained in:
parent
a07c935d34
commit
cac11c9137
1 changed files with 31 additions and 2 deletions
33
docs/api.md
33
docs/api.md
|
@ -4,6 +4,7 @@
|
|||
|
||||
- [Generate a completion](#generate-a-completion)
|
||||
- [Create a Model](#create-a-model)
|
||||
- [Create a Blob](#create-a-blob)
|
||||
- [List Local Models](#list-local-models)
|
||||
- [Show Model Information](#show-model-information)
|
||||
- [Copy a Model](#copy-a-model)
|
||||
|
@ -292,12 +293,13 @@ curl -X POST http://localhost:11434/api/generate -d '{
|
|||
POST /api/create
|
||||
```
|
||||
|
||||
Create a model from a [`Modelfile`](./modelfile.md)
|
||||
Create a model from a [`Modelfile`](./modelfile.md). It is recommended to set `modelfile` to the content of the Modelfile rather than just set `path`. This is a requirement for remote create. Remote model creation should also create any file blobs, fields such as `FROM` and `ADAPTER`, explicitly with the server using [Create a Blob](#create-a-blob) and the value to the path indicated in the response.
|
||||
|
||||
### Parameters
|
||||
|
||||
- `name`: name of the model to create
|
||||
- `path`: path to the Modelfile
|
||||
- `modelfile`: contents of the Modelfile
|
||||
- `stream`: (optional) if `false` the response will be returned as a single response object, rather than a stream of objects
|
||||
|
||||
### Examples
|
||||
|
@ -307,7 +309,8 @@ Create a model from a [`Modelfile`](./modelfile.md)
|
|||
```shell
|
||||
curl -X POST http://localhost:11434/api/create -d '{
|
||||
"name": "mario",
|
||||
"path": "~/Modelfile"
|
||||
"path": "~/Modelfile",
|
||||
"modelfile": "FROM llama2"
|
||||
}'
|
||||
```
|
||||
|
||||
|
@ -321,6 +324,32 @@ A stream of JSON objects. When finished, `status` is `success`.
|
|||
}
|
||||
```
|
||||
|
||||
## Create a Blob
|
||||
|
||||
```shell
|
||||
POST /api/blobs/:digest
|
||||
```
|
||||
|
||||
Create a blob from a file. Returns the server file path.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
- `digest`: the expected SHA256 digest of the file
|
||||
|
||||
### Examples
|
||||
|
||||
```shell
|
||||
curl -X POST http://localhost:11434/api/blobs/sha256:29fdb92e57cf0827ded04ae6461b5931d01fa595843f55d36f5b275a52087dd2 -d @llama2-13b-q4_0.gguf
|
||||
```
|
||||
|
||||
### Response
|
||||
|
||||
```json
|
||||
{
|
||||
"path": "/home/user/.ollama/models/blobs/sha256:29fdb92e57cf0827ded04ae6461b5931d01fa595843f55d36f5b275a52087dd2"
|
||||
}
|
||||
```
|
||||
|
||||
## List Local Models
|
||||
|
||||
```shell
|
||||
|
|
Loading…
Reference in a new issue