docs: align README and GET /retrieve with public docs - #83
Draft
cursor[bot] wants to merge 2 commits into
Draft
Conversation
Align GET /retrieve with the hosted quickstart, which omits preferred_entities. The controller already treats empty values as no preference. Co-authored-by: Christian <ChrisCoder9000@users.noreply.github.com>
Point Resources and retrieval links at /docs/v2 paths (old /docs/rest and /docs/quickstart 404). Mention current /retrieve/context response fields. Co-authored-by: Christian <ChrisCoder9000@users.noreply.github.com>
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
1 participant
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
After the GraphRAG / context retrieval landing on
main, checked public docs at https://brainapi.lumen-labs.ai/docs/v2 against the live API.In-repo fixes (this PR)
preferred_entitiesto""onGET /retrieveso the hosted quickstart (which omits it) works./docs/restand/docs/quickstarttoward/docs/v2paths./retrieve/contextresponse fields (source_passages, optional provenance knobs).Hosted docs still need edits (source not in this repo)
/docs/v2/retrieval/context: document new request knobs (max_facts,max_passages,use_ppr,cross_event_bridges, …) and response fields (source_passages,graph_session_ids,topics,paths, …); fix sample that nestshistorical_contextinside triples./docs/v2/ingestion/structured-data: still documents the oldjson_data/typesshape; live API expects event-centric triples.bin/brainapi.sh→bin/brainapi.Internal-only merges (#80 observations context default, #81 NetworkX event-path) do not need docs changes.