> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cleverschool.systems/llms.txt
> Use this file to discover all available pages before exploring further.

# AI Tools

> Tutorials & Practical Guides

## Practical Guides

Step-by-step walkthroughs to help school leaders, teachers, and support staff leverage Cleverschool's AI capabilities effectively, safely, and in full compliance with school data protection and safeguarding policies.

***

### Guide 1: Accepting AI Terms of Use & Understanding Safe Prompting

Before staff can access generative AI tools, Cleverschool requires a one-time terms acknowledgement to ensure adherence to data protection standards:

**1. Navigate to AI Tools**

From the main navigation sidebar, select **AI Tools** (or navigate to `/ai/index`).

**2. Review the Terms of Use**

If you have not yet agreed to the terms, you will be redirected to `/ai/terms`. Read the guidelines explaining:

* **Centralised Subscription**: Cleverschool connects directly to OpenAI models so individual staff do not need personal subscriptions or accounts.
* **No Pupil Identifiable Information (PII)**: Never input pupil names, addresses, confidential safeguarding notes, or sensitive medical information into prompts.
* **Human in the Loop**: AI is an assistance tool; all generated outputs, lesson materials, and policy interpretations must be verified by a professional before use.
* **Usage Monitoring**: Computational token volume is monitored by school administrators for budgeting and appropriate usage purposes.

**3. Confirm Acceptance**

Click **Agree** at the bottom of the page. Your agreement is recorded in the school audit log, and you are immediately returned to the AI Tools portal.

> [!NOTE]
>
> If you click **Cancel**, you will be redirected safely to your personal dashboard and will not be able to access generative AI tools until terms are accepted.

***

### Guide 2: Creating Classroom Graphics in the AI Image Studio

The Image Studio (`/ai/images`) enables teachers to generate high-quality educational graphics, posters, and flashcard assets from plain English descriptions:

**1. Open the Image Studio**

On the AI Tools dashboard, click the **Image Generator** card (or navigate to `/ai/images`).

**2. Select an Aspect Ratio**

Choose the format best suited for your educational application:

* **Landscape (16:9)**: Ideal for interactive whiteboard presentations, Google Slides / PowerPoint backgrounds, and website banners.
* **Square (1:1)**: Perfect for printed flashcards, matching games, and avatar icons.
* **Portrait (9:16)**: Best for classroom posters, printed newsletter inserts, and mobile notices.

**3. Enter a Descriptive Prompt**

Type a clear description into the prompt box. For example:

* *"A friendly cartoon robot sitting under an oak tree reading an open science book, bright sunny day, watercolour illustration style."*
* *"A cross-section diagram of a medieval castle showing the keep, drawbridge, and ramparts, clean educational textbook style."*

**4. Generate the Image**

Click **Generate**. The synthesized graphic is displayed on screen and automatically saved to your **Your images** gallery at the bottom of the page.

**5. Optional: Modify an Existing Image**

To modify a generated graphic or uploaded picture:

1. Select an image from your gallery or upload a new file (`PNG`, `JPG`, or `GIF`).
2. Describe the requested adjustment (e.g. *"Change the sky to nighttime with a full moon and add stars"*).
3. Click **Generate** to synthesize the modified graphic.

**6. Download or Manage Saved Images**

Click on any thumbnail in **Your images** to view the full-resolution asset and save it to your device. To remove unwanted media, check the selection boxes and click **Delete selected**.

***

### Guide 3: Setting Up a Custom Policy Support Agent (Administrators)

School administrators can create specialized support agents that answer staff queries based strictly on uploaded school policies:

**1. Access AI Administration**

On the AI Tools portal, click the **Manage** button in the header (or navigate to `/ai/admin`).

**2. Create a New Agent**

Click **New Agent** in the top right corner to open the agent configuration modal:

* **Name**: Enter a clear title, such as *Staff Absence & Leave Assistant*.
* **Description**: Provide a brief summary, such as *Instant answers regarding leave of absence, sickness reporting, and special leave entitlements.*
* **Instructions**: Provide custom behavioral guidance. For example:
  ```text theme={null}
  You are a professional HR assistant for school staff.
  - Base all answers strictly on uploaded school policy documents.
  - Always cite the exact policy name and section number.
  - If a policy does not cover the specific scenario, advise the staff member to speak with the School Business Manager.
  - Never fabricate or guess policy rules.
  ```
* **Disclaimer**: Retain or customise the default disclaimer reminding staff of their role as the human in the loop.

**3. Save the Agent**

Click **Save**. The agent is created and assigned a dedicated vector store in the background.

**4. Attach School Policy Documents**

Locate the newly created agent in the table and click **Documents** in the row action menu:

1. Search or filter through your school's **Documents** module.
2. Select the relevant policies (e.g. *Staff Leave of Absence Policy.pdf*, *Staff Code of Conduct.docx*).
3. Click **Store**. The files are processed, semantically embedded, and indexed into the vector store.

> [!TIP]
>
> Whenever a school policy is updated or re-approved by governors, upload the new document version to the Documents module, remove the outdated file from the agent, and attach the revised policy to refresh the semantic index instantly.

***

### Guide 4: Querying Support Agents & Verifying Citations

Staff can interact with custom support agents to retrieve precise policy advice without manually searching through long handbooks:

**1. Select an Agent**

From the AI Tools portal (`/ai/index`), click on the desired support agent card (e.g. *Staff Absence Assistant*).

**2. Ask a Specific Question**

Type your query into the input box at the bottom of the chat screen. For example:

* *"How many days of compassionate leave are staff entitled to for a close family bereavement?"*
* *"What is the procedure if I need to request time off for a medical appointment during teaching hours?"*

**3. Review the Streaming Response**

The agent searches the underlying vector store, retrieves relevant excerpts, and streams a structured response.

**4. Inspect Document Citations**

Review the citations displayed beneath the response identifying the exact document name used to formulate the advice.

**5. Download and Verify Source Files**

If you require full procedural context, click the document citation link to download and read the complete original PDF or Word file.

***

### Guide 5: Auditing School Token Usage & Staff Telemetry (Administrators)

To ensure budget control and oversight across the school:

**1. Open AI Activity**

Navigate to **AI Tools** and click the **AI Activity** button in the header (or navigate to `/ai/activity`).

**2. Filter by Date Range**

Use the date range picker in the header to filter usage by *Today*, *Yesterday*, *This Week*, *This Month*, *Year to Date*, or custom date boundaries.

**3. Review Tenant-Wide Consumption**

Inspect the master table displaying each staff member alongside:

* **Prompt Tokens**: Tokens used in instructions, user queries, and retrieved policy context.
* **Completion Tokens**: Tokens generated by the model in responses and image descriptions.
* **Total Tokens**: Combined computational volume.

**4. Inspect Individual Staff Activity**

Click on any staff member's name (or navigate to `/ai/activity/{user}`) to view a chronological log of individual requests, timestamps, and token volumes.

***

## Next Steps & Guides

> [card] [Conceptual Model & Tour](https://docs.cleverschool.systems/ai/introduction.md)
>
> Understand role permissions, vector stores, and RAG anti-hallucination mechanics.

> [card] [Operational Workflows](./workflows)
>
> Explore end-to-end lifecycles and prompt engineering best practices.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.