Skip to content

Commit 5d0f4b5

Browse files
committed
Added documentation
1 parent cd70b35 commit 5d0f4b5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+19310
-0
lines changed

.DS_Store

0 Bytes
Binary file not shown.

docs/.DS_Store

8 KB
Binary file not shown.

docs/cleanup.js

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
const fs = require('fs');
2+
const path = require('path');
3+
4+
const directoriesToRemove = [
5+
'./docs/local-setup',
6+
'./docs/playwright-web',
7+
'./docs/playwright-api',
8+
'./docs/testing-videos',
9+
];
10+
11+
// Function to delete a directory recursively
12+
function deleteFolderRecursive(directoryPath) {
13+
if (fs.existsSync(directoryPath)) {
14+
fs.readdirSync(directoryPath).forEach((file) => {
15+
const curPath = path.join(directoryPath, file);
16+
if (fs.lstatSync(curPath).isDirectory()) {
17+
deleteFolderRecursive(curPath);
18+
} else {
19+
fs.unlinkSync(curPath);
20+
}
21+
});
22+
fs.rmdirSync(directoryPath);
23+
console.log(`Removed directory: ${directoryPath}`);
24+
}
25+
}
26+
27+
// Delete each directory
28+
directoriesToRemove.forEach((directory) => {
29+
try {
30+
deleteFolderRecursive(directory);
31+
} catch (error) {
32+
console.error(`Error deleting ${directory}:`, error);
33+
}
34+
});
35+
36+
console.log('Cleanup completed!');

docs/docs/.DS_Store

6 KB
Binary file not shown.

docs/docs/ai-courses/AIAgents.mdx

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
import YouTubeVideoEmbed from '@site/src/components/HomepageFeatures/YouTubeVideoEmbed';
6+
7+
# 🧠🤖 Build & Test AI Agents, ChatBots, and RAG with Ollama & Local LLM
8+
9+
<div align="center">
10+
<YouTubeVideoEmbed videoId="qw-X4WUHs5s" />
11+
</div>
12+
13+
---
14+
15+
:::info 💡 **Note**
16+
All the courses are available on **Udemy**, and they almost always have a **`coupon code`** available.
17+
For discounts, please feel free to reach out at **[[email protected]](mailto:[email protected])**.
18+
19+
🎯 **Course Link:**
20+
[Build & Test AI Agents, ChatBots, and RAG with Ollama & Local LLM](https://www.udemy.com/course/build-ai-agent-chatbot-rag-langchain-local-llm/)
21+
:::
22+
23+
---
24+
25+
## 📚 **Course Description**
26+
27+
This course is designed for complete beginners—even if you have **zero knowledge of LangChain**, you’ll learn step-by-step how to build **LLM-based applications** using **local Large Language Models (LLMs)**.
28+
29+
We’ll go beyond development and dive into **evaluating and testing AI agents**, **RAG applications**, and **chatbots** using **RAGAs** to ensure they deliver **accurate** and **reliable results**, following key industry metrics for **AI performance**.
30+
31+
---
32+
33+
### 🚀 **What You’ll Learn**
34+
35+
- **🧠 Fundamentals of LangChain & LangSmith**
36+
Get a solid foundation in building and testing **LLM-based applications**.
37+
38+
- **💬 Chat Message History in LangChain**
39+
Learn how to store conversation data for **chatbots** and **AI agents**.
40+
41+
- **⚙️ Running Parallel & Multiple Chains**
42+
Master advanced techniques like **RunnableParallels** to optimize your **LLM workflows**.
43+
44+
- **🤖 Building Chatbots with LangChain & Streamlit**
45+
Create chatbots with **message history** and an interactive **UI**.
46+
47+
- **🛠️ Tools & Tool Chains in LLMs**
48+
Understand the power of **Tooling**, **Custom Tools**, and how to build **Tool Chains** for **AI applications**.
49+
50+
- **🧑‍💻 Creating AI Agents with LangChain**
51+
Implement **AI agents** that can interact dynamically with **RAG applications**.
52+
53+
- **📚 Implementing RAG with Vector Stores & Local Embeddings**
54+
Develop robust **RAG solutions** with local **LLM embeddings**.
55+
56+
- **🔧 Using AI Agents & RAG with Tooling**
57+
Learn how to integrate **Tooling** effectively while building **LLM Apps**.
58+
59+
- **🚦 Optimizing & Debugging AI Applications with LangSmith**
60+
Enhance your **AI models** and **applications** with **LangSmith's debugging** and **optimization tools**.
61+
62+
- **🧪 Evaluating & Testing LLM Applications with RAGAs**
63+
Apply **hands-on testing strategies** to validate **RAG** and **AI agent** performance.
64+
65+
- **📊 Real-world Projects & Assessments**
66+
Gain practical experience with **RAGAs** and learn to assess the quality and reliability of **AI solutions**.
67+
68+
---
69+
70+
## 🎯 **Learning Experience**
71+
72+
This entire course is taught inside a **Jupyter Notebook** with **Visual Studio**, offering an **interactive**, **guided experience** where you can **run the code seamlessly** and **follow along effortlessly**.
73+
74+
By the end of this course, you’ll have the **confidence** to **build**, **test**, and **optimize AI-powered applications** with ease!

docs/docs/ai-courses/GenAICourse.mdx

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
import YouTubeVideoEmbed from '@site/src/components/HomepageFeatures/YouTubeVideoEmbed';
6+
7+
# 🤖 Using Generative AI in Software Automation Testing
8+
9+
<div align="center">
10+
<YouTubeVideoEmbed videoId="Y7xkCWvUKEk" />
11+
</div>
12+
---
13+
14+
:::info 💡 **Note**
15+
All the courses are available on Udemy, and they almost always have a `coupon code` available.
16+
For discounts, please feel free to reach out at **[[email protected]](mailto:[email protected])**.
17+
18+
🎯 **Course Link:**
19+
[Generative AI in Software Automation Testing](https://www.udemy.com/course/generative-ai-in-software-automation-testing/)
20+
:::
21+
22+
---
23+
24+
## 📚 **Course Description**
25+
26+
This course is crafted for everyone, whether you're new to Software Testing or an experienced professional. Unlock the full potential of **Generative AI** and transform your testing process into something **faster**, **smarter**, and **more efficient**.
27+
28+
### 🚀 **What You’ll Master**
29+
30+
- **🧠 Introduction to Generative AI:**
31+
Understand the foundations of Gen AI and its role in Software Testing.
32+
33+
- **💻 Running Large Language Models (LLMs) Locally:**
34+
Learn how to run models on your machine without paying for external services.
35+
36+
- **📝 Manual Testing with Gen AI:**
37+
Generate manual test cases, test data, and test requirements using grounded Models with the power of AI and RAG.
38+
39+
- **🤖 Automated UI Testing:**
40+
Leverage AI to write, refactor, and optimize automated tests for UI applications.
41+
42+
- **🎭 Playwright UI Testing:**
43+
Use Playwright and AI-driven tools to create smart test scripts and handle complex workflows.
44+
45+
- **🚫 No-code Automation with TestRigor:**
46+
Create powerful automation suites in plain English, even automating SMS, phone calls, and intricate tables.
47+
48+
- **🔗 API Testing:**
49+
Harness PostBots and Gen AI to streamline API testing.
50+
51+
- **🧬 Using Gen AI APIs:**
52+
Add intelligence to your Test Automation code using OpenAI APIs.
53+
54+
- **📍 Model Context Protocol (MCP):**
55+
Run Playwright tests for UI and APIs by leveraging the power of MCP.
56+
57+
---
58+
59+
By the end of this course, you'll have a deep understanding of how **Generative AI** can supercharge your testing process. With hands-on experience, you'll be able to use **AI-enhanced tools** and **LLMs** to simplify complex testing tasks, making your work smoother and more efficient.
60+
61+
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
import YouTubeVideoEmbed from '@site/src/components/HomepageFeatures/YouTubeVideoEmbed';
6+
7+
# 🧠 Understand, Test, and Fine-tune AI Models with Hugging Face
8+
9+
<div align="center">
10+
<YouTubeVideoEmbed videoId="T6-sL0TfAsM" />
11+
</div>
12+
13+
---
14+
15+
:::info 💡 **Note**
16+
All the courses are available on **Udemy**, and they almost always have a **`coupon code`** available.
17+
For discounts, please feel free to reach out at **[[email protected]](mailto:[email protected])**.
18+
19+
🎯 **Course Link:**
20+
[Understand, Test, and Fine-tune AI Models with Hugging Face](https://www.udemy.com/course/ai-with-huggingface/)
21+
:::
22+
23+
---
24+
25+
## 📚 **Course Description**
26+
27+
This course provides a complete journey into **Understanding, Testing, and Fine-tuning AI Models** using the **Hugging Face** library. Whether you are a beginner or an experienced engineer, this course equips you with **hands-on expertise** in every step of the **machine learning pipeline**, from **basic concepts** to **advanced model testing**, **fine-tuning**, and **deployment**.
28+
29+
---
30+
31+
### 🚀 **What You’ll Learn**
32+
33+
1. **📈 Introduction to Machine Learning:**
34+
Lay a strong foundation by exploring key ML concepts and essential terminology.
35+
36+
2. **📊 Working with Natural Language Processing (NLP) Libraries:**
37+
Learn how to process, analyze, and derive insights from textual data using popular NLP tools.
38+
39+
3. **💡 Deep Dive into the Transformers Library:**
40+
Master Hugging Face’s Transformers, the industry standard for building state-of-the-art **NLP** and **LLM** solutions.
41+
42+
4. **🧠 Working with Large Language Models (LLMs):**
43+
Explore multiple methods to interact with and utilize **LLMs** for diverse real-world applications.
44+
45+
5. **🧪 Functional Testing of AI Models:**
46+
Ensure your models perform reliably across different scenarios using systematic testing strategies.
47+
48+
6. **⚖️ Bias and Fairness Testing:**
49+
Implement techniques to detect and mitigate unintended bias, promoting ethical and fair **AI practices**.
50+
51+
7. **📏 Evaluating AI Models:**
52+
Measure performance with robust metrics and refine your models for optimal results.
53+
54+
8. **🤖 Working with AI Agents:**
55+
Build, configure, and integrate **intelligent agents** into your workflows.
56+
57+
9. **🔬 Fine-tuning and Training AI Models:**
58+
Customize pre-trained models or create your own from scratch to meet specific project requirements.
59+
60+
---
61+
62+
By the end of this course, you’ll gain the **knowledge** and **practical experience** needed to confidently **develop**, **test**, and **optimize** your own **Transformer-based models** and **LLMs**, empowering you to thrive in the rapidly evolving world of **AI**.

docs/docs/ai-courses/_category_.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"label": "AI Courses to Learn",
3+
"position": 6,
4+
"collapsed": false,
5+
"link": {
6+
"type": "generated-index",
7+
"description": "AI Courses which helps you learn more on Using it for Testing and Development"
8+
}
9+
}

docs/docs/ai-courses/img/GenAI.png

307 KB
Loading

docs/docs/connection-reference.md

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# Connection Reference
2+
3+
This page provides a comprehensive reference for all connection options available for each supported database type.
4+
5+
## SQLite Connection Options
6+
7+
SQLite is the simplest database to connect to, as it only requires a path to the database file.
8+
9+
```bash
10+
node dist/src/index.js /path/to/your/database.db
11+
```
12+
13+
### Special Paths
14+
15+
- `:memory:` - Creates an in-memory database (data is lost when connection is closed)
16+
- `""` (empty string) - Creates a temporary on-disk database
17+
18+
## SQL Server Connection Options
19+
20+
| Option | Description | Default | Required |
21+
|--------|-------------|---------|----------|
22+
| `--sqlserver` | Specifies SQL Server mode | - | Yes |
23+
| `--server` | SQL Server hostname or IP | - | Yes |
24+
| `--database` | Database name | - | Yes |
25+
| `--user` | SQL Server username | - | No* |
26+
| `--password` | SQL Server password | - | No* |
27+
| `--port` | SQL Server port | 1433 | No |
28+
| `--trustServerCertificate` | Trust server certificate (true/false) | false | No |
29+
| `--connectionTimeout` | Connection timeout in ms | 15000 | No |
30+
| `--requestTimeout` | Request timeout in ms | 15000 | No |
31+
32+
*Windows Authentication is used if user and password are omitted
33+
34+
### Example with Windows Authentication
35+
36+
```bash
37+
node dist/src/index.js --sqlserver --server localhost\\SQLEXPRESS --database Northwind
38+
```
39+
40+
### Example with SQL Authentication
41+
42+
```bash
43+
node dist/src/index.js --sqlserver --server dbserver.example.com --database Northwind --user sa --password P@ssw0rd --port 1433
44+
```
45+
46+
## PostgreSQL Connection Options
47+
48+
| Option | Description | Default | Required |
49+
|--------|-------------|---------|----------|
50+
| `--postgresql` or `--postgres` | Specifies PostgreSQL mode | - | Yes |
51+
| `--host` | PostgreSQL hostname or IP | - | Yes |
52+
| `--database` | Database name | - | Yes |
53+
| `--user` | PostgreSQL username | - | No |
54+
| `--password` | PostgreSQL password | - | No |
55+
| `--port` | PostgreSQL port | 5432 | No |
56+
| `--ssl` | Use SSL connection (true/false) | false | No |
57+
| `--connection-timeout` | Connection timeout in ms | 30000 | No |
58+
59+
### Basic Example
60+
61+
```bash
62+
node dist/src/index.js --postgresql --host localhost --database sample_db --user postgres --password secret
63+
```
64+
65+
### Example with SSL and Custom Port
66+
67+
```bash
68+
node dist/src/index.js --postgresql --host dbserver.example.com --database sample_db --user appuser --password Secure123! --port 5433 --ssl true
69+
```
70+
71+
## Environment Variables
72+
73+
Instead of specifying sensitive credentials on the command line, you can use environment variables:
74+
75+
### SQL Server Environment Variables
76+
77+
- `MSSQL_SERVER` - SQL Server hostname
78+
- `MSSQL_DATABASE` - Database name
79+
- `MSSQL_USER` - SQL Server username
80+
- `MSSQL_PASSWORD` - SQL Server password
81+
82+
### PostgreSQL Environment Variables
83+
84+
- `PGHOST` - PostgreSQL hostname
85+
- `PGDATABASE` - Database name
86+
- `PGUSER` - PostgreSQL username
87+
- `PGPASSWORD` - PostgreSQL password
88+
- `PGPORT` - PostgreSQL port
89+
90+
## Connection Pooling
91+
92+
All database connections use connection pooling for better performance:
93+
94+
- **SQLite**: Uses a single persistent connection
95+
- **SQL Server**: Default pool of 5 connections
96+
- **PostgreSQL**: Default pool of 10 connections
97+
98+
## Connection Security
99+
100+
For secure connections:
101+
102+
1. **SQL Server**: Use `--trustServerCertificate false` in production and ensure proper SSL certificates are installed on the server.
103+
104+
2. **PostgreSQL**: Use `--ssl true` and ensure the server is configured for SSL connections.
105+
106+
3. For all database types, consider using environment variables instead of passing credentials on the command line.
107+
108+
4. Store your Claude Desktop configuration file with appropriate file system permissions.

0 commit comments

Comments
 (0)