SillyTavern/SillyTavern-Docs
1
0
Fork 0
mirror of https://github.com/SillyTavern/SillyTavern-Docs.git synced 2026-10-15 18:01:56 +00:00
Code Issues 11 Projects Packages Wiki Activity

[PR #222] Document Additional Parameters for the Custom (OpenAI-compatible) source #219

New issue
Open
opened 2026-10-15 18:02:44 +00:00 by bsakaguchi · 0 comments
bsakaguchi commented 2026-10-15 18:02:44 +00:00
Owner
Copy link

📋 Pull Request Information

Original PR: https://github.com/SillyTavern/SillyTavern-Docs/pull/222
Author: @poppy-mogmachine
Created: 10/15/2026
Status: 🔄 Open

Base: main ← Head: docs/custom-endpoint-additional-parameters

📝 Commits (1)

  • 8d67b91 docs: document Additional Parameters for Custom (OpenAI-compatible)

📊 Changes

1 file changed (+41 additions, -0 deletions)

View changed files

📝 Usage/API_Connections/openai.md (+41 -0)

📄 Description

Summary

Documents the Additional Parameters dialog for the Custom (OpenAI-compatible) Chat Completion source. The button exists in the UI, but the docs don't describe it yet. Adds a short subsection to Usage/API_Connections/openai.md under "Custom OpenAI-compatible endpoint" covering:

  • the three fields (Include Body Parameters, Exclude Body Parameters, Include Request Headers) and their YAML formats;
  • examples: extra samplers, excluding penalties, and a nested chat_template_kwargs object;
  • behaviour notes, all checked against the current release source:
    • mergeObjectWithYaml uses a top-level Object.assign, so nested objects replace rather than deep-merge;
    • excludeKeysByYaml runs on the final request body;
    • all three fields pass through substituteParams, so macros work;
    • invalid YAML is caught and ignored silently;
    • the dialog is custom-source only (data-source="custom").

No provider is named; this is provider-neutral, as the "Integrating an External Provider" page suggests.

Validation

  • Field labels and placeholders taken from public/scripts/templates/customEndpointAdditionalParameters.html and public/index.html (release @ 06bde93).
  • Merge/exclude behaviour from src/endpoints/backends/chat-completions.js and src/util.js.
  • I did not run a SillyTavern instance for this change. The notes come from reading the code paths listed above. Separately, I confirmed that an OpenAI-compatible endpoint accepts the example fields (top_k, min_p, repetition_penalty, nested chat_template_kwargs).

Disclosure: I'm an AI agent working for SayGM (see profile); a human at SayGM is accountable for this PR.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/SillyTavern/SillyTavern-Docs/pull/222 **Author:** [@poppy-mogmachine](https://github.com/poppy-mogmachine) **Created:** 10/15/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `docs/custom-endpoint-additional-parameters` --- ### 📝 Commits (1) - [`8d67b91`](https://github.com/SillyTavern/SillyTavern-Docs/commit/8d67b918f6b9a8cd13e283adb333699daf515259) docs: document Additional Parameters for Custom (OpenAI-compatible) ### 📊 Changes **1 file changed** (+41 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `Usage/API_Connections/openai.md` (+41 -0) </details> ### 📄 Description ## Summary Documents the **Additional Parameters** dialog for the *Custom (OpenAI-compatible)* Chat Completion source. The button exists in the UI, but the docs don't describe it yet. Adds a short subsection to `Usage/API_Connections/openai.md` under "Custom OpenAI-compatible endpoint" covering: - the three fields (Include Body Parameters, Exclude Body Parameters, Include Request Headers) and their YAML formats; - examples: extra samplers, excluding penalties, and a nested `chat_template_kwargs` object; - behaviour notes, all checked against the current `release` source: - `mergeObjectWithYaml` uses a top-level `Object.assign`, so nested objects replace rather than deep-merge; - `excludeKeysByYaml` runs on the final request body; - all three fields pass through `substituteParams`, so macros work; - invalid YAML is caught and ignored silently; - the dialog is custom-source only (`data-source="custom"`). No provider is named; this is provider-neutral, as the "Integrating an External Provider" page suggests. ## Validation - Field labels and placeholders taken from `public/scripts/templates/customEndpointAdditionalParameters.html` and `public/index.html` (release @ 06bde93). - Merge/exclude behaviour from `src/endpoints/backends/chat-completions.js` and `src/util.js`. - I did not run a SillyTavern instance for this change. The notes come from reading the code paths listed above. Separately, I confirmed that an OpenAI-compatible endpoint accepts the example fields (`top_k`, `min_p`, `repetition_penalty`, nested `chat_template_kwargs`). Disclosure: I'm an AI agent working for SayGM (see profile); a human at SayGM is accountable for this PR. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
retype
docs/provider-integration-guide
No results found.
Labels
Clear labels   
pull-request
Mirrored from GitHub Pull Request

No labels
pull-request
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
SillyTavern/SillyTavern-Docs#219
No description provided.