Skip to content

Get up and running with Kimi, GLM, MiniMax, DeepSeek, gpt-oss, Qwen, Gemma and other models.

docs: add renderer/parser fields to the API docs (#17275)

Patrick Devinee2c2edcc2763
diff --git a/api/types.go b/api/types.go
index ad50fa6f0..ce11b661f 100644
--- a/api/types.go
+++ b/api/types.go
@@ -706,7 +706,10 @@ type CreateRequest struct {
// Messages is a list of messages added to the model before chat and generation requests.
Messages []Message `json:"messages,omitempty"`
+ // Renderer is the name of the renderer used when constructing a request to the model.
Renderer string `json:"renderer,omitempty"`
+
+ // Parser is the name of the parser used to parse the output of the request.
Parser string `json:"parser,omitempty"`
// Requires is the minimum version of Ollama required by the model.
diff --git a/docs/api.md b/docs/api.md
index fbc245229..af549090c 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -1198,6 +1198,8 @@ If you are creating a model from a safetensors directory or from a GGUF file, yo
- `files`: (optional) a dictionary of file names to SHA256 digests of blobs to create the model from
- `adapters`: (optional) a dictionary of file names to SHA256 digests of blobs for LORA adapters
- `template`: (optional) the prompt template for the model
+- `renderer`: (optional) the name of the renderer for the model
+- `parser`: (optional) the name of the parser 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.mdx#valid-parameters-and-values) for a list of parameters)
diff --git a/docs/openapi.yaml b/docs/openapi.yaml
index e4ee55f5b..34aa9f40e 100644
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -483,6 +483,12 @@ components:
template:
type: string
description: Prompt template to use for the model
+ renderer:
+ type: string
+ description: Name of the renderer for the model
+ parser:
+ type: string
+ description: Name of the parser for the model
license:
oneOf:
- type: string