geoffsee/open-web-agent-rs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
7e0b25da59c4e564a1df86b82ca9a296be0fd382
open-web-agent-rs/docs/index.md
geoffsee 7e0b25da59 Add comprehensive documentation and finalize project license 
This commit introduces detailed documentation files, including installation, configuration, API, agents, and an index. It also updates the README with new sections and registers the MIT license for the project. These changes aim to improve clarity and ease of use for developers and contributors.
2025-05-23 10:59:17 -04:00

2.2 KiB
Raw Blame History

web-agent-rs Documentation

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

Table of Contents

Overview

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, finance queries, 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 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 web-agent-rs are welcome! Please feel free to submit issues and pull requests to improve the project.