Autograph Naming updates - #1075
Open
nicos-arango wants to merge 2 commits into
Open
Conversation
Contributor
|
Deploy Preview Available Via |
Contributor
📝 WalkthroughWalkthroughThe documentation defines AutoGraph as creating a Context Graph and AutoRAG as deploying retrievers over it. AutoGraph Studio now documents the complete build and retrieval workflow. GraphRAG web-interface content is replaced or redirected to AutoGraph Studio and API-based workflows. ChangesAutoGraph terminology and architecture
Estimated code review effort: 3 (Moderate) | ~25 minutes Sequence Diagram(s)sequenceDiagram
participant User
participant AutoGraph Studio
participant AutoGraph
participant AutoRAG
User->>AutoGraph Studio: Upload documents and configure providers
AutoGraph Studio->>AutoGraph: Build Corpus Graph
AutoGraph-->>AutoGraph Studio: Provide Context Graph
AutoGraph Studio->>AutoRAG: Deploy retriever
AutoRAG-->>User: Provide search and chat options
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 7
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@site/content/_index.md`:
- Around line 138-141: Update the Context Graph description to refer to the
simpler option as “lighter processing” or its actual strategy name, such as
“vector_rag,” instead of “a lighter partition,” while preserving the contrast
with full entity extraction.
In `@site/content/agentic-ai-suite/autograph/architecture.md`:
- Around line 16-20: Update the AutoGraph architecture description to identify
the cross-graph join as the shared-property match between rags.rag_partition_id
and Documents.partition_id. Explicitly state that this is not a stored edge or
AQL traversal relationship, replacing the ambiguous “partition_id link” wording
in the Context Graph explanation.
In `@site/content/agentic-ai-suite/autograph/web-interface.md`:
- Line 152: Update the sentence near the Context Graph description to state that
the Context Graph consists only of the Corpus Graph and Knowledge Graph,
excluding credentials and retriever services listed above.
- Around line 116-119: Update the “Start build” workflow description so it
documents a single consistent sequence: starting the build deploys the AutoGraph
service, then the user waits for deployment and clicks “Build Corpus Graph” to
create the Corpus Graph. Remove or revise the claim that Start build itself
builds the Corpus Graph.
- Around line 188-200: Revise the “Generate strategies and build the Knowledge
Graph” section to separate strategy generation from Knowledge Graph
orchestration: describe Generate strategies as creating strategy profiles via
the RAG Strategizer, then add instructions to initiate orchestration through the
orchestration action so Importer workers build the graph. Document the resulting
Knowledge Graph completion state and keep the guidance about unbuilt Corpus
Graph changes aligned with the strategy-generation step.
In `@site/content/agentic-ai-suite/importer/setup.md`:
- Line 15: Standardize the UI label to “AutoGraph Studio” in the links at
site/content/agentic-ai-suite/importer/setup.md:15-15,
site/content/agentic-ai-suite/importer/_index.md:25-25, and
site/content/agentic-ai-suite/importer/autograph-integration.md:18-18, replacing
“AutoGraph web interface” in each location.
In `@site/content/agentic-ai-suite/retriever/_index.md`:
- Line 26: Update the AutoGraph web interface link in the Importer-based
standalone graph section so it points only to a standalone-compatible workflow;
otherwise separate the standalone and AutoGraph project workflows, keeping the
project-specific Studio guidance out of the standalone user path.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: e2c38b6f-598b-4de8-afcc-3f2fe8e4c7ad
⛔ Files ignored due to path filters (1)
site/content/images/Agentic-AI-Suite-Overview.svgis excluded by!**/*.svg
📒 Files selected for processing (27)
site/content/_index.mdsite/content/agentic-ai-suite/_index.mdsite/content/agentic-ai-suite/autograph/architecture.mdsite/content/agentic-ai-suite/autograph/design-guide.mdsite/content/agentic-ai-suite/autograph/quick-start.mdsite/content/agentic-ai-suite/autograph/reference/error-handling.mdsite/content/agentic-ai-suite/autograph/reference/importing-files.mdsite/content/agentic-ai-suite/autograph/setup.mdsite/content/agentic-ai-suite/autograph/web-interface.mdsite/content/agentic-ai-suite/graphml/quick-start.mdsite/content/agentic-ai-suite/graphml/ui.mdsite/content/agentic-ai-suite/graphrag/_index.mdsite/content/agentic-ai-suite/graphrag/quick-start.mdsite/content/agentic-ai-suite/graphrag/technical-overview.mdsite/content/agentic-ai-suite/graphrag/web-interface.mdsite/content/agentic-ai-suite/importer/_index.mdsite/content/agentic-ai-suite/importer/architecture.mdsite/content/agentic-ai-suite/importer/autograph-integration.mdsite/content/agentic-ai-suite/importer/llm-configuration.mdsite/content/agentic-ai-suite/importer/setup.mdsite/content/agentic-ai-suite/retriever/_index.mdsite/content/agentic-ai-suite/retriever/llm-configuration.mdsite/content/agentic-ai-suite/retriever/search-methods/deep-search.mdsite/content/agentic-ai-suite/retriever/search-methods/unified-search.mdsite/content/contextual-data-platform/architecture.mdsite/content/contextual-data-platform/release-notes.mdsite/static/_redirects
💤 Files with no reviewable changes (1)
- site/content/agentic-ai-suite/graphrag/web-interface.md
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
2 participants
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.
Description
New PR with naming updates across the docs.
Upstream PRs
Summary by CodeRabbit