What data for this category looks like
Open-source maintainers, release managers, and documentation maintainers create and maintain the core version release-related documentation for this category. Daily deliverables include Release Notes, change logs, version tags, and release checklists. Teams source data from Git tags, merge records, CI artifacts, and Issue milestones. Maintainers push updates once per version. Individual data entries typically include version number, change classification, breaking change description, associated CI artifact hash, and corresponding milestone Issue number. No unified fixed unit exists; values vary based on version content.
Constraints on knowledge base retrieval and recall
Data for this category comes from code repositories and CI workflows. Retrieval systems must support precise matching using structured fields such as version numbers and hash values. Updates occur once per version, so knowledge bases must support incremental synchronization. This avoids performance losses from full rebuilds. The change classification process takes significant time, so retrieval systems must support filtering by change type. Failures can lead to user upgrade failures or community misunderstandings. Recall results must meet higher accuracy and completeness standards, with no omission of critical content such as breaking changes. Data structures vary significantly across versions, so retrieval models must adapt to change description texts of varying lengths.
Configuration settings
| Configuration Item | Recommended Setting | Rationale |
|---|---|---|
similarity | 0.75–0.85 | Filter low-relevance change entries to avoid interfering with pre-sales or support queries |
limit | Top 10 entries | Align with the number of entries per version in Release Notes, to avoid exceeding context window limits |
searchMode | Hybrid vector retrieval + keyword search | Balance precise matching of structured fields such as version numbers and hash values, and semantic understanding of change descriptions |
usingReRank | Enabled | Re-rank recalled change entries by relevance, to highlight critical content such as breaking changes |
datasetSearchUsingExtensionQuery | Enabled | Expand user natural language queries into composite queries including version numbers and change types, to improve recall accuracy |
collectionIds | Bind to the Release Notes knowledge base collection for the corresponding version | Narrow retrieval scope to avoid retrieving documentation from other categories |
Three common configuration mistakes
- Observation: An error prompt appears immediately after creating a knowledge base directory. Cause: The directory is not linked to the correct Release Notes collection, so retrieval cannot match documentation for the corresponding version.
- Observation: A provider error displays when clicking to add a folder in the knowledge base. Cause: Data source access permissions are not configured, so original Release Notes data such as Git tags and merge records cannot be pulled.
- Observation: An authentication failure prompt appears when synchronizing a knowledge base collection via API. Cause: The correct
collectionIdsparameter is not included in the API request, or the used key lacks access permissions for the corresponding collection.
How to verify correct configuration
- Run a precise query for a specific version number, and confirm the returned results include Release Notes entries for that version.
- Trigger a query containing the keyword "breaking change", and confirm recalled results prioritize relevant content.
- Check the FastGPT v4.17.0 knowledge base update log, and confirm the latest Release Notes data has synchronized at the per-version cadence.
- Call the retrieval interface, and confirm the number of returned results matches the configured
limitvalue.
The values provided are common starting points and should be measured against the reader's own samples.
Question material comes from public community discussions. Configuration values are common starting points and should be measured against your own samples. Verified on 2026-10-19.