From 93d45d7a0464e534c0211f2fb9d720b1855ce43a Mon Sep 17 00:00:00 2001 From: Alexander Gusak Date: Fri, 12 Dec 2025 00:14:45 +0000 Subject: [PATCH] docs: fix link to modelfile.mdx (#13220) --- api/client.go | 2 +- docs/api.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/api/client.go b/api/client.go index 9a8f89e49..c70516899 100644 --- a/api/client.go +++ b/api/client.go @@ -347,7 +347,7 @@ type CreateProgressFunc func(ProgressResponse) error // Create creates a model from a [Modelfile]. fn is a progress function that // behaves similarly to other methods (see [Client.Pull]). // -// [Modelfile]: https://github.com/ollama/ollama/blob/main/docs/modelfile.md +// [Modelfile]: https://github.com/ollama/ollama/blob/main/docs/modelfile.mdx func (c *Client) Create(ctx context.Context, req *CreateRequest, fn CreateProgressFunc) error { return c.stream(ctx, http.MethodPost, "/api/create", req, func(bts []byte) error { var resp ProgressResponse diff --git a/docs/api.md b/docs/api.md index 99ceaa11a..03f6dbea1 100644 --- a/docs/api.md +++ b/docs/api.md @@ -50,7 +50,7 @@ Generate a response for a given prompt with a provided model. This is a streamin Advanced parameters (optional): - `format`: the format to return a response in. Format can be `json` or a JSON schema -- `options`: additional model parameters listed in the documentation for the [Modelfile](./modelfile.md#valid-parameters-and-values) such as `temperature` +- `options`: additional model parameters listed in the documentation for the [Modelfile](./modelfile.mdx#valid-parameters-and-values) such as `temperature` - `system`: system message to (overrides what is defined in the `Modelfile`) - `template`: the prompt template to use (overrides what is defined in the `Modelfile`) - `stream`: if `false` the response will be returned as a single response object, rather than a stream of objects @@ -507,7 +507,7 @@ The `message` object has the following fields: Advanced parameters (optional): - `format`: the format to return a response in. Format can be `json` or a JSON schema. -- `options`: additional model parameters listed in the documentation for the [Modelfile](./modelfile.md#valid-parameters-and-values) such as `temperature` +- `options`: additional model parameters listed in the documentation for the [Modelfile](./modelfile.mdx#valid-parameters-and-values) such as `temperature` - `stream`: if `false` the response will be returned as a single response object, rather than a stream of objects - `keep_alive`: controls how long the model will stay loaded into memory following the request (default: `5m`) @@ -1189,7 +1189,7 @@ If you are creating a model from a safetensors directory or from a GGUF file, yo - `template`: (optional) the prompt template for the model - `license`: (optional) a string or list of strings containing the license or licenses for the model - `system`: (optional) a string containing the system prompt for the model -- `parameters`: (optional) a dictionary of parameters for the model (see [Modelfile](./modelfile.md#valid-parameters-and-values) for a list of parameters) +- `parameters`: (optional) a dictionary of parameters for the model (see [Modelfile](./modelfile.mdx#valid-parameters-and-values) for a list of parameters) - `messages`: (optional) a list of message objects used to create a conversation - `stream`: (optional) if `false` the response will be returned as a single response object, rather than a stream of objects - `quantize` (optional): quantize a non-quantized (e.g. float16) model @@ -1698,7 +1698,7 @@ Generate embeddings from a model Advanced parameters: - `truncate`: truncates the end of each input to fit within context length. Returns error if `false` and context length is exceeded. Defaults to `true` -- `options`: additional model parameters listed in the documentation for the [Modelfile](./modelfile.md#valid-parameters-and-values) such as `temperature` +- `options`: additional model parameters listed in the documentation for the [Modelfile](./modelfile.mdx#valid-parameters-and-values) such as `temperature` - `keep_alive`: controls how long the model will stay loaded into memory following the request (default: `5m`) - `dimensions`: number of dimensions for the embedding @@ -1817,7 +1817,7 @@ Generate embeddings from a model Advanced parameters: -- `options`: additional model parameters listed in the documentation for the [Modelfile](./modelfile.md#valid-parameters-and-values) such as `temperature` +- `options`: additional model parameters listed in the documentation for the [Modelfile](./modelfile.mdx#valid-parameters-and-values) such as `temperature` - `keep_alive`: controls how long the model will stay loaded into memory following the request (default: `5m`) ### Examples