Skip to content

chore: add custom apps guide#352

Open
sr-remsha wants to merge 12 commits intomainfrom
custom-apps-guide
Open

chore: add custom apps guide#352
sr-remsha wants to merge 12 commits intomainfrom
custom-apps-guide

Conversation

@sr-remsha
Copy link
Contributor

@sr-remsha sr-remsha commented Nov 12, 2025

Description of changes

Added documents with instructions on how to create custom aps in DIAL

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@sr-remsha sr-remsha changed the title Custom apps guide chore: add custom apps guide Jan 7, 2026
@sr-remsha sr-remsha marked this pull request as ready for review January 7, 2026 14:35
@sr-remsha sr-remsha requested a review from YuriyIvon January 7, 2026 14:36

6. Configure new application:

* Set **Editor URL** to `http://localhost:3301`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This list is using bullets, while other lists in the instruction use numbers. I would make everything consistent.

3. In the **Properties** page for the “Custom Application” switch to the **Parameters** tab.
4. If you see just the “Login” link in the center of the tab – click it and log in with “dial-admin” as a user and “dial” as a password.

> **Tip**: Now you should see a sample custom configuration page with a single input field called “Number”. In this sample application, this property controls how many times your input will be repeated in the end-user chat in response. The configuration page is served by the URL specified in the “Editor URL” property of the application type.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't sound like a tip, it is rather a note

1. In the **Add app** dropdown select **Custom Runner**.
1. Set **Name** to “Custom Runner Instance 1” and click **Next**.

Now you should see a sample custom configuration page with a single input field called “Number”. In this sample application, this property controls how many times your input will be repeated in the end-user chat in response. The configuration page is served by the URL specified in the “Editor URL” property of the application type.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add "Note" title for consistency with the second tutorial


> **Note**: Please note that the “custom-app” section of this URL must be equal to the name passed to a call to “add_chat_completion” method in the underlying DIAL backend application. If you use a different name in your backend, the URL from above must be updated accordingly.

![](../img/custom-runner8.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For some reason is rendered as text, does not show the picture


The diagram below shows the most complete logical structure of a Custom Standalone Application:

![](../img/overview6.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any way to limit the width a little? The image is too big


And the following diagram – the most complete structure of a Custom Application Runner:

![](../img/overview7.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any way to limit the width a little? The image is too big

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants