tiennm99/DocsGPT
1
0 Fork 0
mirror of https://github.com/tiennm99/DocsGPT.git synced 2026-10-17 10:13:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: visibility settings

Browse Source
This commit is contained in:
Alex committed 2026-06-10 01:40:53 +01:00
1 parent f31910569f
commit 160736f075
18 files changed
+359 -101
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/content/Agents/api.mdx
+2 -1
View File
@@ -59,7 +59,8 @@ Common request body fields:
| `conversation_id` | `string` | No | `/api/answer`, `/stream` | Continue an existing conversation. |
| `history` | `string` (JSON-encoded array) | No | `/api/answer`, `/stream` | Used for new conversations. Format: `[{\"prompt\":\"...\",\"response\":\"...\"}]`. |
| `model_id` | `string` | No | `/api/answer`, `/stream` | Override model for this request. |
| `save_conversation` | `boolean` | No | `/api/answer`, `/stream` | Default `true`. If `false`, no conversation is persisted. |
| `save_conversation` | `boolean` | No | `/api/answer`, `/stream` | Deprecated, no effect. Conversations are always persisted; use `visibility` to control sidebar listing. |
| `visibility` | `string` | No | `/api/answer`, `/stream` | `"listed"` shows the conversation in the owner's sidebar. Any other value (or omitting it) persists it hidden. Default `hidden`. |
| `passthrough` | `object` | No | `/api/answer`, `/stream` | Dynamic values injected into prompt templates. |
| `prompt_id` | `string` | No | `/api/answer`, `/stream` | Ignored when `api_key` already defines prompt. |
| `active_docs` | `string` or `string[]` | No | `/api/answer`, `/stream` | Overrides active docs when not using key-owned source config. |
docs/content/Agents/openai-compatible.mdx
+7 -7
View File
@@ -80,14 +80,14 @@ When an override is active, the agent's prompt template is replaced wholesale
## Conversation Persistence
Conversations are **not persisted by default** (stateless, like most OpenAI clients expect). Opt in per request:
Conversations are **always persisted** server-side, and the response includes
`docsgpt.conversation_id`. They never appear in the agent owner's sidebar —
`/v1` traffic is stored hidden, so external clients can't clutter the owner's
conversation list.
```json
{ "docsgpt": { "save_conversation": true } }
```
The response will include `docsgpt.conversation_id`.
The legacy `{ "docsgpt": { "save_conversation": true } }` opt-in from older
releases (when `/v1` was stateless by default) is deprecated and ignored.
## When to Use Native Endpoints Instead
Use [`/api/answer` or `/stream`](/Agents/api) if you need server-side attachments, `passthrough` template variables, explicit `conversation_id` reuse, or persistence by default.
Use [`/api/answer` or `/stream`](/Agents/api) if you need server-side attachments, `passthrough` template variables, explicit `conversation_id` reuse, or sidebar visibility control via `visibility`.