Introduction

A high-level overview of Saiku’s architecture and its core components, with guidance on navigating the detailed API documentation.

Saiku’s evolution is driven by community contributions. Whether it’s enhancing the documentation, refining the code, or adding new functionalities, your input is valued and appreciated.

Introduction to Saiku API Reference

Welcome to the Saiku API Reference. This documentation provides a holistic view of Saiku’s architecture, highlighting its core components and functionalities. Saiku is built with modularity and flexibility in mind, enabling robust AI-driven automation and interactions.

Overall Architecture

Saiku’s architecture is centered around several key components, each designed to perform specific roles within the system:

1. Agent

• Role: The Agent acts as the central coordinator for Saiku, handling user interactions, decision-making, and task execution.
• Documentation: Detailed information about the Agent’s properties and methods can be found in Agent.

2. Language Learning Models (LLMs)

• Purpose: LLMs, such as OpenAI, Google VertexAI, and others, provide natural language processing capabilities, crucial for understanding and generating human-like text.
• Documentation: For specifics on each model, visit the LLMs section under LLMs.

3. Actions

• Functionality: Actions are modular units responsible for executing specific tasks, like file operations, data processing, and more.
• Documentation: Explore the various actions and their usages in Actions.

Navigating the Documentation

This API reference is structured to give you a comprehensive understanding of each component:

• In-Depth Information: Each section dives deep into the methods, properties, and functionalities of the respective components.
• Practical Examples: Where applicable, you’ll find practical examples to illustrate how to utilize these components in real-world scenarios.
• Interaction Flow: Gain insights into how these components interact with each other to form the cohesive functionality of Saiku.

---

We encourage you to explore each section to gain a full understanding of Saiku’s capabilities and how they can be applied to your projects.