docs: document API key enablement, server-side limits, cleanup and processing status on the knowledge base sync page - #1427
Open
silentoplayz wants to merge 1 commit into
Conversation
…ocessing status on the knowledge base sync page
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
I compared the knowledge base sync page with the knowledge and files routers and the API key checks.
POST /api/v1/knowledge/{id}/sync/diffand.../sync/cleanup), and the manifest entry carries asizefield as well.ENABLE_KNOWLEDGE_FILE_RETENTIONis on, when the file is linked elsewhere, or when the caller is neither owner nor admin. A file with no stored hash is re-uploaded once on the first sync.RAG_FILE_MAX_SIZEanswered with HTTP 413,RAG_ALLOWED_FILE_EXTENSIONSwith HTTP 400) regardless of oikb'smax-size.GET /api/v1/files/{id}/process/statusreports completion./api/v1/knowledgeand/api/v1/files.Related issue or discussion
None.
Checklist
Notes for reviewers
Sources on
dev:routers/knowledge.py(FileManifestEntry, the sync routes, cleanup),routers/files.py(size and extension checks,process/status),config.py(ENABLE_API_KEYS,ENABLE_API_KEYS_ENDPOINT_RESTRICTIONS,API_KEYS_ALLOWED_ENDPOINTS), andutils/auth.py. oikb's own flags are unchanged.