Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,5 @@ tern.conf
docs/public/
docs/resources/
docs/.hugo_build.lock
docs/hugo
docs/hugo.tar.gz
13 changes: 8 additions & 5 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,13 @@ embapi is a PostgreSQL-backed vector database with pgvector support, providing a

## Quick Links

- [Getting Started](/getting-started/) - Installation and first steps
- [Concepts](/concepts/) - Understand how embapi works
- [API Reference](/api/) - Complete API documentation
- [Guides](/guides/) - How-to guides for common tasks
- [Getting Started](getting-started/) - Installation and first steps
- [Concepts](concepts/) - Understand how embapi works
- [API Reference](api/) - Complete API documentation
- [Guides](guides/) - How-to guides for common tasks
- [Deployment](deployment/) - Production deployment guide
- [Development](development/) - Contributing and development guide
- [Reference](reference/) - Technical reference and specifications

## Getting Help

Expand All @@ -51,4 +54,4 @@ curl -X POST http://localhost:8880/v1/users \
# See the Getting Started guide for a complete walkthrough
```

Ready to get started? Head over to the [Installation Guide](/getting-started/installation/).
Ready to get started? Head over to the [Installation Guide](getting-started/installation/).
2 changes: 1 addition & 1 deletion docs/content/api/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ Projects can be made publicly accessible by setting `public_read: true` when cre
- Embeddings
- Similarity search

See [Public Access Documentation](/docs/PUBLIC_ACCESS.md) for details.
See [Public Projects Guide](../../guides/public-projects/) for details.

## Security Best Practices

Expand Down
5 changes: 3 additions & 2 deletions docs/content/api/endpoints/llm-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ instances (user-specific)
└── can be shared with other users
```

For complete details, see [LLM Service Refactoring Documentation](/docs/LLM_SERVICE_REFACTORING.md).
For complete details, see [Database Schema Reference](../../reference/database-schema/) and [LLM Services Concepts](../../concepts/llm-services/).

---

Expand Down Expand Up @@ -515,4 +515,5 @@ When an instance is shared:

- [API Standards](api-standards/) - Managing API standard definitions
- [Projects](projects/) - Projects require an LLM service instance
- [LLM Service Refactoring](/docs/LLM_SERVICE_REFACTORING.md) - Complete architecture documentation
- [LLM Services Concepts](../../concepts/llm-services/) - LLM service architecture and design
- [Database Schema](../../reference/database-schema/) - Complete database schema documentation
2 changes: 1 addition & 1 deletion docs/content/api/endpoints/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -501,4 +501,4 @@ When uploading embeddings, metadata will be validated against this schema. Inval
- [LLM Services](llm-services/) - Managing LLM service instances
- [Embeddings](embeddings/) - Adding and retrieving embeddings
- [Similars](similars/) - Similarity search
- [Public Access](/docs/PUBLIC_ACCESS.md) - Public project configuration
- [Public Projects Guide](../../guides/public-projects/) - Public project configuration
12 changes: 7 additions & 5 deletions docs/content/concepts/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ embapi is a vector database designed for Retrieval Augmented Generation (RAG) wo

## Key Components

- **Users** - Individual accounts with authentication
- **Projects** - Containers for embeddings with access control
- **Embeddings** - Vector representations of text with metadata
- **LLM Services** - Configurations for embedding models
- **Similarity Search** - Find similar documents using vector distance
- **[Users](users-and-auth/)** - Individual accounts with authentication
- **[Projects](projects/)** - Containers for embeddings with access control
- **[Embeddings](embeddings/)** - Vector representations of text with metadata
- **[LLM Services](llm-services/)** - Configurations for embedding models
- **[Similarity Search](similarity-search/)** - Find similar documents using vector distance
- **[Metadata](metadata/)** - Structured data with validation and filtering
- **[Architecture](architecture/)** - Technical architecture and design

## Architecture

Expand Down
16 changes: 8 additions & 8 deletions docs/content/guides/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ Step-by-step guides for common tasks and workflows with embapi.

This section contains practical guides for using embapi in real-world scenarios:

- **RAG Workflows** - Implement Retrieval Augmented Generation
- **Project Sharing** - Collaborate with other users
- **Public Projects** - Enable unauthenticated access
- **Ownership Transfer** - Move projects between users
- **Metadata Validation** - Ensure data quality with schemas
- **Metadata Filtering** - Exclude documents from similarity search
- **Batch Operations** - Work with multiple embeddings efficiently
- **Instance Management** - Configure LLM service instances
- **[RAG Workflows](rag-workflow/)** - Implement Retrieval Augmented Generation
- **[Project Sharing](project-sharing/)** - Collaborate with other users
- **[Public Projects](public-projects/)** - Enable unauthenticated access
- **[Ownership Transfer](ownership-transfer/)** - Move projects between users
- **[Metadata Validation](metadata-validation/)** - Ensure data quality with schemas
- **[Metadata Filtering](metadata-filtering/)** - Exclude documents from similarity search
- **[Batch Operations](batch-operations/)** - Work with multiple embeddings efficiently
- **[Instance Management](instance-management/)** - Configure LLM service instances

These guides complement the API reference by providing context and best practices for common use cases.