From 38cd80d52c7aefe8562f4bb1d3126ad2904d85c1 Mon Sep 17 00:00:00 2001
From: ParthSareen <parth.sareen@ollama.com>
Date: Thu, 19 Dec 2024 14:17:29 -0800
Subject: [PATCH] Add dry run option for chat request

---
 api/types.go     | 13 +++++++++----
 server/routes.go | 12 ++++++++++++
 2 files changed, 21 insertions(+), 4 deletions(-)

diff --git a/api/types.go b/api/types.go
index 8d6a91e3a..35070b79f 100644
--- a/api/types.go
+++ b/api/types.go
@@ -103,6 +103,10 @@ type ChatRequest struct {
 	// Tools is an optional list of tools the model has access to.
 	Tools `json:"tools,omitempty"`
 
+	// DryRun when true will prepare and validate the request but stop before sending it to the model.
+	// This allows inspecting how the prompt would be constructed and what parameters would be used.
+	DryRun bool `json:"dry_run,omitempty"`
+
 	// Options lists model-specific options.
 	Options map[string]interface{} `json:"options"`
 }
@@ -185,10 +189,11 @@ func (t *ToolFunction) String() string {
 // ChatResponse is the response returned by [Client.Chat]. Its fields are
 // similar to [GenerateResponse].
 type ChatResponse struct {
-	Model      string    `json:"model"`
-	CreatedAt  time.Time `json:"created_at"`
-	Message    Message   `json:"message"`
-	DoneReason string    `json:"done_reason,omitempty"`
+	Model        string    `json:"model"`
+	CreatedAt    time.Time `json:"created_at"`
+	Message      Message   `json:"message"`
+	DoneReason   string    `json:"done_reason,omitempty"`
+	DryRunOutput string    `json:"dry_run_output,omitempty"`
 
 	Done bool `json:"done"`
 
diff --git a/server/routes.go b/server/routes.go
index 4ac34c5d5..56ad844f0 100644
--- a/server/routes.go
+++ b/server/routes.go
@@ -1572,6 +1572,18 @@ func (s *Server) ChatHandler(c *gin.Context) {
 		return
 	}
 
+	if req.DryRun {
+		c.JSON(http.StatusOK, api.ChatResponse{
+			Model:        req.Model,
+			CreatedAt:    time.Now().UTC(),
+			Message:      api.Message{Role: "assistant", Content: ""},
+			Done:         true,
+			DoneReason:   "dry_run",
+			DryRunOutput: prompt,
+		})
+		return
+	}
+
 	slog.Debug("chat request", "images", len(images), "prompt", prompt)
 
 	ch := make(chan any)