Skip to content

dmr: request and response inspector #23128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

dmr: request and response inspector #23128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion content/manuals/ai/model-runner/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
- Package GGUF files as OCI Artifacts and publish them to any Container Registry
- Run and interact with AI models directly from the command line or from the Docker Desktop GUI
- Manage local models and display logs
- Display prompts and responses details

## Requirements

Expand Down Expand Up @@ -188,7 +189,7 @@
{{< tabs group="release" >}}
{{< tab name="From Docker Desktop">}}

1. Select **Models** and select the **Local** tab
1. Select **Models** and select the **Local** tab.
1. Click the play button. The interactive chat screen opens.

![screencapture of the Local view](./images/dmr-run.png)
Expand All @@ -203,6 +204,8 @@

## Troubleshooting

### Display the logs

To troubleshoot potential issues, display the logs:

{{< tabs group="release" >}}
Expand All @@ -220,6 +223,28 @@
{{< /tab >}}
{{< /tabs >}}

### Inpect requests and responses

Check failure on line 226 in content/manuals/ai/model-runner/_index.md

View workflow job for this annotation

GitHub Actions / validate (vale) 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Inpect'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Inpect'?", "location": {"path": "content/manuals/ai/model-runner/_index.md", "range": {"start": {"line": 226, "column": 5}}}, "severity": "ERROR"}

Inspecting requests and responses helps you diagnose model-related issues.
For example, you can evaluate context usage to verify you stay within the model's context
window or display the full body of a request to control the parameters you are passing to your models
when developing with a framework.

In Docker Desktop, to inspect the requests and responses for each model:

1. Select **Models** and select the **Requests** tab. This view displays all the requests to all models:
- The time the request was sent.
- The model name and version
- The prompt/request
- The context usage
- The time it took for the response to be generated.
2. Select one of the requests to display further details:
- In the **Overview** tab, view the token usage, response metadata and generation speed, and the actual prompt and response.
- In the **Request** and **Response** tabs, view the full JSON payload of the request and the response.

> [!NOTE]
> You can also display the requests for a specific model when you select a model and then select the **Requests** tab.

## Publish a model

> [!NOTE]
Expand Down