Add comprehensive Text-to-Cypher documentation

[Copilot]

Overview

This PR adds comprehensive documentation for Text-to-Cypher functionality to the FalkorDB docs, addressing issue #[issue_number].

Text-to-Cypher is a powerful feature that enables developers to convert natural language questions into Cypher queries using Large Language Models (LLMs), making graph databases more accessible to users who may not be familiar with the Cypher query language.

Changes

New Documentation (cypher/text-to-cypher.md)

Created a complete 308-line documentation page covering:

• Overview & Introduction: What Text-to-Cypher is and how it bridges the gap between natural language and graph queries
• How It Works: Detailed 5-step process from ontology extraction to response synthesis
• Getting Started: Prerequisites, installation instructions, and a complete working example
• Use Cases: Three practical examples demonstrating:
  • Product catalog queries
  • Relationship traversal
  • Complex aggregations with GROUP BY
• Advanced Features:
  • Custom LLM configuration for different providers
  • Streaming responses for real-time interactions
  • Ontology management strategies
• Best Practices: Four key recommendations for effective usage
• Integration Patterns: Examples with LangChain and LlamaIndex
• Performance Considerations: Query optimization and caching strategies
• Troubleshooting: Common issues and their solutions
• Resources: Links to GraphRAG SDK, related documentation, and external resources

Updates to Existing Files

• cypher/index.md: Added a new "Text-to-Cypher" section linking to the new documentation
• .wordlist.txt: Added technical terms (ontology, LiteModel) to prevent false positives in spellcheck

Example Usage

The documentation includes practical examples like:

# Ask questions in natural language
chat = kg.chat_session()
response = chat.send_message("What products are available?")
print(response["response"])

# Ask follow-up questions with maintained context
response = chat.send_message("Which one is the most expensive?")
print(response["response"])

Documentation Quality

• ✅ All internal links verified to point to existing documentation pages
• ✅ Consistent formatting with existing documentation style
• ✅ Proper Jekyll frontmatter with correct navigation order (24)
• ✅ Multiple code examples demonstrating real-world usage
• ✅ Integration examples with popular LLM frameworks

Related Resources

The documentation connects users to:

• GraphRAG SDK for implementation details
• Cypher Language for query syntax reference
• LLM Framework Integrations for additional tools
• Agentic Memory for persistent context

This addition makes it easier for developers to understand and implement natural language querying capabilities in their FalkorDB applications.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Add docs for Text-to-Cypher</issue_title>
<issue_description>

---

This repo is using Opire - what does it mean? 👇

💵 Everyone can add rewards for this issue commenting /reward 100 (replace 100 with the amount).
🕵️‍♂️ If someone starts working on this issue to earn the rewards, they can comment /try to let everyone know!
🙌 And when they open the PR, they can comment /claim FalkorDB/docs#210 either in the PR description or in a PR's comment.

🪙 Also, everyone can tip any user commenting /tip 20 @gkorland (replace 20 with the amount, and @gkorland with the user to tip).

📖 If you want to learn more, check out our documentation.

Comments on the Issue (you are @copilot in this section)

Fixes #210

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}