chore:split documents
This commit is contained in:
parent
1efc90e10f
commit
2ca15679cb
9 changed files with 31 additions and 31 deletions
22
README.md
22
README.md
|
|
@ -1,10 +1,10 @@
|
||||||
# go-llm-agent
|
# rony-llm-agent
|
||||||
|
|
||||||
> 🔑 **Librería core reutilizable** para construir agentes LLM en Go.
|
> 🔑 **Librería core reutilizable** para construir agentes LLM en Go.
|
||||||
|
|
||||||
Esta librería es el corazón de varios proyectos de Victor Vargas:
|
Esta librería es el corazón de varios proyectos de Victor Vargas:
|
||||||
- [`harness`](https://github.com/VictorVargas/harness) — AI agent harness para desarrollo de software (TUI)
|
- [`harness`](https://github.com/VictorVargas/rony-harness) — AI agent harness para desarrollo de software (TUI)
|
||||||
- [`chat-bot`](https://github.com/VictorVargas/chat-bot) — Chatbot HTTP para portfolios y sitios web
|
- [`chat-bot`](https://github.com/VictorVargas/rony-chat-bot) — Chatbot HTTP para portfolios y sitios web
|
||||||
|
|
||||||
Provee toda la lógica **genérica** de un agente LLM:
|
Provee toda la lógica **genérica** de un agente LLM:
|
||||||
|
|
||||||
|
|
@ -27,14 +27,14 @@ Provee toda la lógica **genérica** de un agente LLM:
|
||||||
## 📦 Instalación
|
## 📦 Instalación
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
go get github.com/VictorVargas/go-llm-agent
|
go get github.com/VictorVargas/rony-llm-agent
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🔧 Setup del proyecto (si vas a contribuir)
|
## 🔧 Setup del proyecto (si vas a contribuir)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/VictorVargas/go-llm-agent.git
|
git clone https://github.com/VictorVargas/rony-llm-agent.git
|
||||||
cd go-llm-agent
|
cd rony-llm-agent
|
||||||
|
|
||||||
# El go.mod ya existe con module + go version
|
# El go.mod ya existe con module + go version
|
||||||
# Las dependencias se agregan automáticamente cuando escribes código:
|
# Las dependencias se agregan automáticamente cuando escribes código:
|
||||||
|
|
@ -52,9 +52,9 @@ package main
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"github.com/VictorVargas/go-llm-agent/pkg/agent"
|
"github.com/VictorVargas/rony-llm-agent/pkg/agent"
|
||||||
"github.com/VictorVargas/go-llm-agent/pkg/llm"
|
"github.com/VictorVargas/rony-llm-agent/pkg/llm"
|
||||||
"github.com/VictorVargas/go-llm-agent/pkg/persona"
|
"github.com/VictorVargas/rony-llm-agent/pkg/persona"
|
||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
|
|
@ -128,8 +128,8 @@ MIT — ver [`LICENSE`](./LICENSE).
|
||||||
|
|
||||||
## 🔗 Proyectos que usan esta librería
|
## 🔗 Proyectos que usan esta librería
|
||||||
|
|
||||||
- [`VictorVargas/harness`](https://github.com/VictorVargas/harness) — TUI agent para software dev
|
- [`VictorVargas/rony-harness`](https://github.com/VictorVargas/rony-harness) — TUI agent para software dev
|
||||||
- [`VictorVargas/chat-bot`](https://github.com/VictorVargas/chat-bot) — HTTP chatbot
|
- [`VictorVargas/rony-chat-bot`](https://github.com/VictorVargas/rony-chat-bot) — HTTP chatbot
|
||||||
|
|
||||||
## 📚 Documentación adicional
|
## 📚 Documentación adicional
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
# go-llm-agent — Documentación
|
# rony-llm-agent — Documentación
|
||||||
|
|
||||||
Documentación técnica detallada de la librería.
|
Documentación técnica detallada de la librería.
|
||||||
|
|
||||||
|
|
@ -6,7 +6,7 @@ Documentación técnica detallada de la librería.
|
||||||
|
|
||||||
```
|
```
|
||||||
┌────────────────────────────────────────────────────────────────┐
|
┌────────────────────────────────────────────────────────────────┐
|
||||||
│ go-llm-agent (pkg/) │
|
│ rony-llm-agent (pkg/) │
|
||||||
│ │
|
│ │
|
||||||
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────────┐ │
|
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────────┐ │
|
||||||
│ │ agent │ │ persona │ │ tools │ │
|
│ │ agent │ │ persona │ │ tools │ │
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
# 🏗️ go-llm-agent — Architecture
|
# 🏗️ rony-llm-agent — Architecture
|
||||||
|
|
||||||
**Versión:** 1.0
|
**Versión:** 1.0
|
||||||
**Autor:** Victor Hugo Vargas
|
**Autor:** Victor Hugo Vargas
|
||||||
|
|
@ -14,14 +14,14 @@
|
||||||
|
|
||||||
## 🎯 1. Visión de la Librería
|
## 🎯 1. Visión de la Librería
|
||||||
|
|
||||||
### 1.1 ¿Qué es go-llm-agent?
|
### 1.1 ¿Qué es rony-llm-agent?
|
||||||
|
|
||||||
Una librería Go que provee toda la lógica **genérica y reusable** para construir agentes basados en LLMs. No es un producto final — es el cimiento sobre el cual se construyen productos específicos.
|
Una librería Go que provee toda la lógica **genérica y reusable** para construir agentes basados en LLMs. No es un producto final — es el cimiento sobre el cual se construyen productos específicos.
|
||||||
|
|
||||||
**Productos que la consumen:**
|
**Productos que la consumen:**
|
||||||
|
|
||||||
- [`VictorVargas/harness`](https://github.com/VictorVargas/harness) — AI agent harness para desarrollo de software (TUI CLI)
|
- [`VictorVargas/rony-harness`](https://github.com/VictorVargas/rony-harness) — AI agent harness para desarrollo de software (TUI CLI)
|
||||||
- [`VictorVargas/chat-bot`](https://github.com/VictorVargas/chat-bot) — Chatbot HTTP para portfolios y sitios web
|
- [`VictorVargas/rony-chat-bot`](https://github.com/VictorVargas/rony-chat-bot) — Chatbot HTTP para portfolios y sitios web
|
||||||
|
|
||||||
### 1.2 Principios de diseño
|
### 1.2 Principios de diseño
|
||||||
|
|
||||||
|
|
@ -51,7 +51,7 @@ Una librería Go que provee toda la lógica **genérica y reusable** para constr
|
||||||
│ usan interfaces públicas
|
│ usan interfaces públicas
|
||||||
▼
|
▼
|
||||||
┌─────────────────────────────────────────────────────────────────┐
|
┌─────────────────────────────────────────────────────────────────┐
|
||||||
│ go-llm-agent (pkg/ — API pública) │
|
│ rony-llm-agent (pkg/ — API pública) │
|
||||||
│ │
|
│ │
|
||||||
│ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ │
|
│ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ │
|
||||||
│ │ agent │ │ llm │ │ persona │ │ tools │ ... │
|
│ │ agent │ │ llm │ │ persona │ │ tools │ ... │
|
||||||
|
|
@ -386,7 +386,7 @@ func (s *Sandbox) WriteFile(path string, data []byte, perm os.FileMode) error
|
||||||
| Path encoding (`%2e%2e`) | No detectado | Detectado por stdlib |
|
| Path encoding (`%2e%2e`) | No detectado | Detectado por stdlib |
|
||||||
| Null bytes en path | Depende del OS | Manejado por stdlib |
|
| Null bytes en path | Depende del OS | Manejado por stdlib |
|
||||||
|
|
||||||
> 🔒 Por eso la librería **requiere Go 1.26+** (ver [README §16.1.3.1](https://github.com/VictorVargas/harness/blob/main/docs/architecture.md#16131)).
|
> 🔒 Por eso la librería **requiere Go 1.26+** (ver [README §16.1.3.1](https://github.com/VictorVargas/rony-harness/blob/main/docs/architecture.md#16131)).
|
||||||
|
|
||||||
### 3.7 Configuration (`pkg/config/`)
|
### 3.7 Configuration (`pkg/config/`)
|
||||||
|
|
||||||
|
|
@ -487,7 +487,7 @@ Capa 6: Secret redaction → no expone secrets en logs/outputs
|
||||||
Para tests deterministas, los productos pueden usar `pkg/llm/mock`:
|
Para tests deterministas, los productos pueden usar `pkg/llm/mock`:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
import "github.com/VictorVargas/go-llm-agent/pkg/llm/mock"
|
import "github.com/VictorVargas/rony-llm-agent/pkg/llm/mock"
|
||||||
|
|
||||||
mockClient := mock.New(mock.Responses{
|
mockClient := mock.New(mock.Responses{
|
||||||
{Match: "hola", Response: "¡Hola! ¿Cómo estás?"},
|
{Match: "hola", Response: "¡Hola! ¿Cómo estás?"},
|
||||||
|
|
@ -498,7 +498,7 @@ mockClient := mock.New(mock.Responses{
|
||||||
### 6.2 Mock Memory
|
### 6.2 Mock Memory
|
||||||
|
|
||||||
```go
|
```go
|
||||||
import "github.com/VictorVargas/go-llm-agent/pkg/rag/mock"
|
import "github.com/VictorVargas/rony-llm-agent/pkg/rag/mock"
|
||||||
|
|
||||||
memory := mock.NewMemory([]rag.Fragment{
|
memory := mock.NewMemory([]rag.Fragment{
|
||||||
{Content: "doc1", ProjectID: "test"},
|
{Content: "doc1", ProjectID: "test"},
|
||||||
|
|
|
||||||
|
|
@ -145,7 +145,7 @@ package myprovider
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"github.com/VictorVargas/go-llm-agent/pkg/llm"
|
"github.com/VictorVargas/rony-llm-agent/pkg/llm"
|
||||||
)
|
)
|
||||||
|
|
||||||
type Client struct {
|
type Client struct {
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
# 🚀 go-llm-agent — Phase 2 Features
|
# 🚀 rony-llm-agent — Phase 2 Features
|
||||||
|
|
||||||
**Versión:** 1.0
|
**Versión:** 1.0
|
||||||
**Autor:** Victor Hugo Vargas
|
**Autor:** Victor Hugo Vargas
|
||||||
|
|
@ -8,7 +8,7 @@
|
||||||
> 📚 **Documentos relacionados:**
|
> 📚 **Documentos relacionados:**
|
||||||
> - [`architecture.md`](./architecture.md) — Core interfaces (LLMClient, Tool, Agent Loop, etc.)
|
> - [`architecture.md`](./architecture.md) — Core interfaces (LLMClient, Tool, Agent Loop, etc.)
|
||||||
> - [`components.md`](./components.md) — Referencia por paquete
|
> - [`components.md`](./components.md) — Referencia por paquete
|
||||||
> - Productos que consumen estas features: [`harness`](https://github.com/VictorVargas/harness), [`chat-bot`](https://github.com/VictorVargas/chat-bot)
|
> - Productos que consumen estas features: [`harness`](https://github.com/VictorVargas/rony-harness), [`chat-bot`](https://github.com/VictorVargas/rony-chat-bot)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -726,4 +726,4 @@ import "github.com/tetratelabs/wazero"
|
||||||
|
|
||||||
- [`architecture.md`](./architecture.md) — Core architecture
|
- [`architecture.md`](./architecture.md) — Core architecture
|
||||||
- [`components.md`](./components.md) — Per-package reference
|
- [`components.md`](./components.md) — Per-package reference
|
||||||
- Productos: [`harness`](https://github.com/VictorVargas/harness), [`chat-bot`](https://github.com/VictorVargas/chat-bot)
|
- Productos: [`harness`](https://github.com/VictorVargas/rony-harness), [`chat-bot`](https://github.com/VictorVargas/rony-chat-bot)
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
> Ejemplos de uso de `go-llm-agent` en distintos contextos.
|
> Ejemplos de uso de `rony-llm-agent` en distintos contextos.
|
||||||
|
|
||||||
## 📁 Contenido planeado
|
## 📁 Contenido planeado
|
||||||
|
|
||||||
|
|
|
||||||
2
go.mod
2
go.mod
|
|
@ -1,3 +1,3 @@
|
||||||
module github.com/VictorVargas/go-llm-agent
|
module github.com/VictorVargas/rony-llm-agent
|
||||||
|
|
||||||
go 1.26
|
go 1.26
|
||||||
|
|
@ -51,7 +51,7 @@ type ProviderCapabilities struct {
|
||||||
## Uso
|
## Uso
|
||||||
|
|
||||||
```go
|
```go
|
||||||
import "github.com/VictorVargas/go-llm-agent/pkg/llm/providers/anthropic"
|
import "github.com/VictorVargas/rony-llm-agent/pkg/llm/providers/anthropic"
|
||||||
|
|
||||||
client, err := anthropic.New(anthropic.Config{
|
client, err := anthropic.New(anthropic.Config{
|
||||||
APIKey: os.Getenv("ANTHROPIC_API_KEY"),
|
APIKey: os.Getenv("ANTHROPIC_API_KEY"),
|
||||||
|
|
@ -77,7 +77,7 @@ for chunk, err := range client.Stream(ctx, req) {
|
||||||
## Mock para tests
|
## Mock para tests
|
||||||
|
|
||||||
```go
|
```go
|
||||||
import "github.com/VictorVargas/go-llm-agent/pkg/llm/mock"
|
import "github.com/VictorVargas/rony-llm-agent/pkg/llm/mock"
|
||||||
|
|
||||||
mockClient := mock.New(mock.Responses{
|
mockClient := mock.New(mock.Responses{
|
||||||
{Match: "hola", Response: "¡Hola! ¿Cómo estás?"},
|
{Match: "hola", Response: "¡Hola! ¿Cómo estás?"},
|
||||||
|
|
|
||||||
|
|
@ -58,8 +58,8 @@ type Embedder interface {
|
||||||
## Uso
|
## Uso
|
||||||
|
|
||||||
```go
|
```go
|
||||||
import "github.com/VictorVargas/go-llm-agent/pkg/rag"
|
import "github.com/VictorVargas/rony-llm-agent/pkg/rag"
|
||||||
import "github.com/VictorVargas/go-llm-agent/pkg/rag/backends/chroma"
|
import "github.com/VictorVargas/rony-llm-agent/pkg/rag/backends/chroma"
|
||||||
|
|
||||||
backend, _ := chroma.New(chroma.Config{
|
backend, _ := chroma.New(chroma.Config{
|
||||||
Path: "~/.local/share/rony/chroma",
|
Path: "~/.local/share/rony/chroma",
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue