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

update docs

Browse source
This commit is contained in:
Michael Yang 2023-11-15 11:01:32 -08:00
parent 1901044b07
commit 71d71d0988
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/api.md
View file

@ -4,7 +4,6 @@
- [Generate a completion](#generate-a-completion) - [Generate a completion](#generate-a-completion)
- [Create a Model](#create-a-model) - [Create a Model](#create-a-model)
- [Create a Blob](#create-a-blob)
- [List Local Models](#list-local-models) - [List Local Models](#list-local-models)
- [Show Model Information](#show-model-information) - [Show Model Information](#show-model-information)
- [Copy a Model](#copy-a-model) - [Copy a Model](#copy-a-model)
@ -298,7 +297,7 @@ Create a model from a [`Modelfile`](./modelfile.md). It is recommended to set `m
### Parameters ### Parameters
- `name`: name of the model to create - `name`: name of the model to create
- `path`: path to the Modelfile - `path`: path to the Modelfile (deprecated: please use modelfile instead)
- `modelfile`: contents of 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 - `stream`: (optional) if `false` the response will be returned as a single response object, rather than a stream of objects
@ -324,7 +323,7 @@ A stream of JSON objects. When finished, `status` is `success`.
} }
``` ```
## Create a Blob ### Create a Blob
```shell ```shell
POST /api/blobs/:digest POST /api/blobs/:digest
@ -332,17 +331,17 @@ POST /api/blobs/:digest
Create a blob from a file. Returns the server file path. Create a blob from a file. Returns the server file path.
### Query Parameters #### Query Parameters
- `digest`: the expected SHA256 digest of the file - `digest`: the expected SHA256 digest of the file
### Examples #### Examples
```shell ```shell
curl -X POST http://localhost:11434/api/blobs/sha256:29fdb92e57cf0827ded04ae6461b5931d01fa595843f55d36f5b275a52087dd2 -d @llama2-13b-q4_0.gguf curl -X POST http://localhost:11434/api/blobs/sha256:29fdb92e57cf0827ded04ae6461b5931d01fa595843f55d36f5b275a52087dd2 -d @llama2-13b-q4_0.gguf
``` ```
### Response #### Response
```json ```json
{ {