> For the complete documentation index, see [llms.txt](https://docs.kodesage.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kodesage.ai/welcome-to-kodesage/the-kodesage-engine.md).
# The Kodesage engine
Platform overview
The Kodesage platform is architecturally designed for on-premises deployment, encapsulating its core functionality within Docker containerized environments for enhanced modularity and isolation. The system's logical structure is centered around a virtual machine hosting the Kodesage services, with external integration points to source code repositories, ticketing systems, and documentation.
Key elements of the solution include an ingestion service to process and analyze the source code, creating a searchable vector database and a comprehensive knowledge graph.
This system architecture enables essential services such as semantic code search ("Ask Kodesage"), automated document generation, and issue ticketing integration, powered by a dedicated Large Language Model (LLM). The LLM instances are hosted separately, emphasizing the system's distributed nature, which enhances both the scalability and reliability of the service.
This design facilitates seamless integration, while the on-prem LLM is used to maintain high throughput and low latency. The clear separation of services ensures a maintainable and scalable system.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.kodesage.ai/welcome-to-kodesage/the-kodesage-engine.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
