geoffsee/open-web-agent-rs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
2b14d119d214e3df230b4cf8a1493476e8437e76
open-web-agent-rs/docs/index.md
geoffsee eed180fdf2 Rename project to "open-web-agent-rs" across all files 
Updated project name from "web-agent-rs" to "open-web-agent-rs" in configuration files, documentation, and source code. This change ensures consistency across the project and reflects the new naming convention. Removed unused entries from `.gitignore` and adjusted Docker commands accordingly.
2025-05-27 15:23:07 -04:00

2.2 KiB
Raw Blame History

open-web-agent-rs Documentation

Welcome to the documentation for open-web-agent-rs, a GenAIScript host for integration into conversational AI applications.

Table of Contents

Overview

open-web-agent-rs is a server that hosts GenAIScript agents for integration into conversational AI applications. It provides a simple API for creating and consuming stream resources that execute various agents to perform tasks like web search, news search, image generation, and web scraping.

Architecture

The application is built with Rust using the Axum web framework. It uses GenAIScript for defining agent behavior and provides a streaming API for consuming agent responses.

Key Components

  1. Server - The main application server that handles HTTP requests and responses
  2. Agents - GenAIScript files that define agent behavior
  3. Handlers - Rust functions that process HTTP requests
  4. Authentication - FIPS204 signature-based authentication system
  5. Configuration - Environment variables for configuring the application

Getting Started

To get started with open-web-agent-rs, follow these steps:

  1. Read the Installation Guide to set up the project
  2. Configure the application using the Configuration Guide
  3. Learn how to use the API with the API Documentation
  4. Understand the authentication system with the Authentication documentation
  5. Create your own agents using the Agents Guide

Security Considerations

Please note that this project has not undergone a formal security assessment. You should do your own evaluation before using it in production environments.

Contributing

Contributions to open-web-agent-rs are welcome! Please feel free to submit issues and pull requests to improve the project.