DOC-797 | Natural language to AQL service (txt2aql / AQLizer) #794
Conversation
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
|
Deploy Preview Available Via |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
maxkernbach
reviewed
Nov 3, 2025
There was a problem hiding this comment.
Thank you for rasing this PR @nerpaula, I have added a few comments for consideration.
site/content/3.12/data-science/graphrag/services/natural-language-to-aql.md
Outdated
Show resolved
Hide resolved
site/content/3.12/data-science/graphrag/services/natural-language-to-aql.md
Outdated
Show resolved
Hide resolved
maxkernbach
reviewed
Nov 4, 2025
site/content/3.12/data-science/graphrag/services/natural-language-to-aql.md
Outdated
Show resolved
Hide resolved
maxkernbach
approved these changes
Nov 4, 2025
There was a problem hiding this comment.
Thanks for implementing further improvements @nerpaula. I have approved the PR and added one minor suggestion.
| These parameters must be provided in the install request sent to GenAI service. | ||
| ```bash | ||
| curl --request GET \ | ||
| --url <ExternalEndpoint>:8529/graph-rag/<serviceID>/v1/health \ |
There was a problem hiding this comment.
Bug: Missing https in health-check curl example URL
The health check curl example is missing the https:// protocol prefix in its URL. This makes the URL invalid and inconsistent with other API examples in the document.
…o longer needed, add aqlizer mode
Co-authored-by: maxkernbach <maximilian.kernbach@gmail.com>
nerpaula
commented
Nov 5, 2025
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.
Description
Natural language to AQL service (txt2aql / AQLizer) documentation.
Note
Rewrites the Natural Language to AQL docs with deployment/config steps, REST endpoints (including streaming and AQLizer), output formats, and troubleshooting while removing gRPC-specific content.
titleandmenuTitleto “Natural Language to AQL”.envparameters, provider options (OpenAI/OpenRouter/self-hosted), service status, and health checks with example curls.POST /v1/process_text: General LLM Q&A with example request/response.POST /v1/process_text_stream: Streaming responses with default mode and AQLizer mode for schema-aware AQL generation.POST /v1/translate_query: NL-to-AQL execution with multi-format outputs (NL,AQL,JSON), examples, and usage guidance.Written by Cursor Bugbot for commit cfde74f. This will update automatically on new commits. Configure here.