Knowledge Base Index
38 articles | 504 concepts | 131 categories
Categories
API Gateway Layer
- auth/init — Central re-export hub for authentication and user management — This module serves as the public API facade for the entire authentication domain
API Router / Endpoint Layer
- ee/cloud/kb/init — Knowledge Base Domain Package Initialization and Endpoint Exposure — This module serves as the entry point for the Knowledge Base (KB) domain within
- ee.cloud.workspace — Router re-export for FastAPI workspace endpoints — This module serves as the public entry point for the workspace domain’s FastAPI
API Router Layer
- deps — FastAPI dependency injection layer for cloud router authentication and authorization — This module provides FastAPI dependency functions that extract and validate user
API Router — Bootstrap & Mounting
- ee.cloud.init — Cloud domain orchestration and FastAPI application bootstrap — This module is the entry point for PocketPaw’s enterprise cloud layer. It bootst
API contract layer
- schemas — Pydantic request/response contracts for session lifecycle operations — This module defines the HTTP API contracts (request bodies and response payloads
- schemas — Pydantic request/response data models for workspace domain operations — This module defines the contract between the workspace API layer and its consume
API gateway / facade
- chat/init.py — Entry point for chat domain with groups, messages, and WebSocket real-time capabilities — This module serves as the public API gateway for the chat domain, re-exporting t
API layer
- core — Enterprise JWT authentication with cookie and bearer transport for FastAPI — This module implements a complete authentication system for PocketPaw using fast
- schemas — Pydantic request/response models for agent lifecycle and discovery operations — This module defines four Pydantic BaseModel classes that serve as the contract l
- schemas — Request/response data validation for the knowledge base REST API — This module defines Pydantic request/response schemas for the knowledge base dom
API router / integration layer
- ee.cloud.agents — Package initialization and router export for enterprise cloud agent functionality — This is a minimal package initialization module that serves as the public API en
API router and HTTP layer
- ee.cloud.sessions — Entry point and router export for session management APIs — This module serves as the public API entry point for the sessions package, expor
API router layer
- pockets.init — Entry point and public API aggregator for the pockets subsystem — This module serves as the public interface for the enterprise cloud pockets subs
- router — FastAPI authentication endpoints and user profile management — This module exposes HTTP endpoints for user authentication, registration, profil
API schemas and data models
- schemas — Pydantic models for authentication request/response validation — This module defines three Pydantic BaseModel classes that standardize the shape
Access Control & Security
- Workspace Domain Service - Business Logic for Enterprise Cloud — A stateless service layer that encapsulates workspace business logic including C
Adapter/Bridge Pattern
- backend_adapter — Adapter that makes PocketPaw’s agent backends usable as knowledge base CompilerBackends — This module provides
PocketPawCompilerBackend, an adapter class that implement
Agent Infrastructure
- backend_adapter — Adapter that makes PocketPaw’s agent backends usable as knowledge base CompilerBackends — This module provides
PocketPawCompilerBackend, an adapter class that implement
Agent Integration Layer
- ripple_normalizer — Normalizes AI-generated pocket specifications into a consistent, persistence-ready format — This module provides a single public function,
normalize_ripple_spec(), that t
Async/Concurrency Patterns
- events — In-process async pub/sub event bus for decoupled cross-domain side effects — This module provides a simple in-process publish/subscribe event bus that enable
Authentication & Authorization
- auth/init — Central re-export hub for authentication and user management — This module serves as the public API facade for the entire authentication domain
- AuthService: Business Logic Layer for Authentication and User Profile Management — AuthService is a stateless FastAPI service that encapsulates authentication and
- deps — FastAPI dependency injection layer for cloud router authentication and authorization — This module provides FastAPI dependency functions that extract and validate user
Backend Service Architecture
- Workspace Domain Service - Business Logic for Enterprise Cloud — A stateless service layer that encapsulates workspace business logic including C
Business Logic Layer
- AuthService: Business Logic Layer for Authentication and User Profile Management — AuthService is a stateless FastAPI service that encapsulates authentication and
CRUD
- pocket — Data models for Pocket workspaces with widgets, teams, and collaborative agents — This module defines the core document models (Pocket, Widget, WidgetPosition) th
CRUD operations
- router — FastAPI authentication endpoints and user profile management — This module exposes HTTP endpoints for user authentication, registration, profil
- schemas — Pydantic request/response contracts for session lifecycle operations — This module defines the HTTP API contracts (request bodies and response payloads
CRUD schema definition
- schemas — Pydantic request/response models for agent lifecycle and discovery operations — This module defines four Pydantic BaseModel classes that serve as the contract l
Chat & Messaging
- message — Data model for group chat messages with mentions, reactions, and threading support — This module defines the Pydantic data models that represent chat messages in gro
Cloud Domain — Orchestration
- ee.cloud.init — Cloud domain orchestration and FastAPI application bootstrap — This module is the entry point for PocketPaw’s enterprise cloud layer. It bootst
Cloud Infrastructure
- Cloud Document Models Re-export Hub for Beanie ODM — This module serves as a central re-export point for Beanie ODM document definiti
Collaboration Features
- comment — Threaded comments on pockets and widgets with workspace isolation — This module defines the data models for a collaborative commenting system that e
Core Domain Model
- comment — Threaded comments on pockets and widgets with workspace isolation — This module defines the data models for a collaborative commenting system that e
Cross-Domain Communication
- events — In-process async pub/sub event bus for decoupled cross-domain side effects — This module provides a simple in-process publish/subscribe event bus that enable
Data Model / Persistence
- comment — Threaded comments on pockets and widgets with workspace isolation — This module defines the data models for a collaborative commenting system that e
- notification — In-app notification data model and persistence for user workspace events — This module defines the data models for in-app notifications that inform users a
Data Model Layer
- message — Data model for group chat messages with mentions, reactions, and threading support — This module defines the Pydantic data models that represent chat messages in gro
Data Transformation & Normalization
- ripple_normalizer — Normalizes AI-generated pocket specifications into a consistent, persistence-ready format — This module provides a single public function,
normalize_ripple_spec(), that t
Database Models
- Cloud Document Models Re-export Hub for Beanie ODM — This module serves as a central re-export point for Beanie ODM document definiti
Domain Model
- message — Data model for group chat messages with mentions, reactions, and threading support — This module defines the Pydantic data models that represent chat messages in gro
Enterprise Edition (EE) Architecture
- Cloud Document Models Re-export Hub for Beanie ODM — This module serves as a central re-export point for Beanie ODM document definiti
Enterprise Edition Cloud Infrastructure
- ee/cloud/kb/init — Knowledge Base Domain Package Initialization and Endpoint Exposure — This module serves as the entry point for the Knowledge Base (KB) domain within
Enterprise Features
- ee.cloud.workspace — Router re-export for FastAPI workspace endpoints — This module serves as the public entry point for the workspace domain’s FastAPI
Enterprise SaaS
- Workspace Domain Service - Business Logic for Enterprise Cloud — A stateless service layer that encapsulates workspace business logic including C
Enterprise cloud features
- ee.cloud.sessions — Entry point and router export for session management APIs — This module serves as the public API entry point for the sessions package, expor
Error Handling & Global Middleware
- ee.cloud.init — Cloud domain orchestration and FastAPI application bootstrap — This module is the entry point for PocketPaw’s enterprise cloud layer. It bootst
Event-Driven Architecture
- ee.cloud.init — Cloud domain orchestration and FastAPI application bootstrap — This module is the entry point for PocketPaw’s enterprise cloud layer. It bootst
- events — In-process async pub/sub event bus for decoupled cross-domain side effects — This module provides a simple in-process publish/subscribe event bus that enable
- notification — In-app notification data model and persistence for user workspace events — This module defines the data models for in-app notifications that inform users a
Facade & Re-export Pattern
- auth/init — Central re-export hub for authentication and user management — This module serves as the public API facade for the entire authentication domain
FastAPI HTTP endpoints
- router — FastAPI authentication endpoints and user profile management — This module exposes HTTP endpoints for user authentication, registration, profil
FastAPI Middleware & Dependency Injection
- deps — FastAPI dependency injection layer for cloud router authentication and authorization — This module provides FastAPI dependency functions that extract and validate user
FastAPI application architecture
- ee.cloud.agents — Package initialization and router export for enterprise cloud agent functionality — This is a minimal package initialization module that serves as the public API en
FastAPI integration
- license — Enterprise license validation and feature gating for cloud deployments — This module provides cryptographic validation of signed license keys, caching of
HTTP validation layer
- schemas — Pydantic models for authentication request/response validation — This module defines three Pydantic BaseModel classes that standardize the shape
Infrastructure Layer — Lifecycle Management
- ee.cloud.init — Cloud domain orchestration and FastAPI application bootstrap — This module is the entry point for PocketPaw’s enterprise cloud layer. It bootst
Infrastructure/Foundation
- events — In-process async pub/sub event bus for decoupled cross-domain side effects — This module provides a simple in-process publish/subscribe event bus that enable
Knowledge Base — Integration Layer
- backend_adapter — Adapter that makes PocketPaw’s agent backends usable as knowledge base CompilerBackends — This module provides
PocketPawCompilerBackend, an adapter class that implement
Knowledge Management Domain
- ee/cloud/kb/init — Knowledge Base Domain Package Initialization and Endpoint Exposure — This module serves as the entry point for the Knowledge Base (KB) domain within
LLM Backend Abstraction
- backend_adapter — Adapter that makes PocketPaw’s agent backends usable as knowledge base CompilerBackends — This module provides
PocketPawCompilerBackend, an adapter class that implement
Module Architecture / Facade Pattern
- ee.cloud.workspace — Router re-export for FastAPI workspace endpoints — This module serves as the public entry point for the workspace domain’s FastAPI
MongoDB / Beanie
- file — Cloud storage metadata document for managing file references — This module defines the
FileObjdocument model that stores metadata about file
MongoDB document
- agent — Agent configuration and metadata storage for workspace-scoped AI agents — This module defines the data models for storing agent configurations in the OCEA
MongoDB persistence
- base — Foundational document model with automatic timestamp management for MongoDB persistence — This module provides
TimestampedDocument, a base class that extends Beanie’s O - session — Cloud-tracked chat session document model for pocket-scoped conversations — The session module defines the Session document model that represents individual
- workspace — Data model for organization workspaces in multi-tenant enterprise deployments — This module defines the core data models that represent a workspace: the contain
MongoDB/Beanie Persistence
- message — Data model for group chat messages with mentions, reactions, and threading support — This module defines the Pydantic data models that represent chat messages in gro
MongoDB/Beanie — database technology and ORM layer
- group — Multi-user chat channels with AI agent participants — This module defines the data models for chat groups/channels that support multip
Multi-Tenant Access Control
- deps — FastAPI dependency injection layer for cloud router authentication and authorization — This module provides FastAPI dependency functions that extract and validate user
Multi-tenant Architecture
- comment — Threaded comments on pockets and widgets with workspace isolation — This module defines the data models for a collaborative commenting system that e
Notification / User Communication
- notification — In-app notification data model and persistence for user workspace events — This module defines the data models for in-app notifications that inform users a
ODM integration
- db — MongoDB connection and Beanie ODM lifecycle management for PocketPaw cloud infrastructure — This module provides a centralized, application-level abstraction for managing M
Package structure and organization
- ee.cloud.sessions — Entry point and router export for session management APIs — This module serves as the public API entry point for the sessions package, expor
Pydantic DTOs
- schemas — Pydantic request/response data models for workspace domain operations — This module defines the contract between the workspace API layer and its consume
Security Infrastructure
- auth/init — Central re-export hub for authentication and user management — This module serves as the public API facade for the entire authentication domain
Session management domain
- ee.cloud.sessions — Entry point and router export for session management APIs — This module serves as the public API entry point for the sessions package, expor
Specification Management
- ripple_normalizer — Normalizes AI-generated pocket specifications into a consistent, persistence-ready format — This module provides a single public function,
normalize_ripple_spec(), that t
User Management
- AuthService: Business Logic Layer for Authentication and User Profile Management — AuthService is a stateless FastAPI service that encapsulates authentication and
Utility & Infrastructure
- ripple_normalizer — Normalizes AI-generated pocket specifications into a consistent, persistence-ready format — This module provides a single public function,
normalize_ripple_spec(), that t
Workspace / Multi-tenancy
- notification — In-app notification data model and persistence for user workspace events — This module defines the data models for in-app notifications that inform users a
Workspace Domain
- ee.cloud.workspace — Router re-export for FastAPI workspace endpoints — This module serves as the public entry point for the workspace domain’s FastAPI
Workspace-Scoped Feature
- ee/cloud/kb/init — Knowledge Base Domain Package Initialization and Endpoint Exposure — This module serves as the entry point for the Knowledge Base (KB) domain within
agent management
- agent — Agent configuration and metadata storage for workspace-scoped AI agents — This module defines the data models for storing agent configurations in the OCEA
agents domain
- schemas — Pydantic request/response models for agent lifecycle and discovery operations — This module defines four Pydantic BaseModel classes that serve as the contract l
application lifecycle
- db — MongoDB connection and Beanie ODM lifecycle management for PocketPaw cloud infrastructure — This module provides a centralized, application-level abstraction for managing M
architectural pattern — facade
- db — Backward compatibility facade for cloud database initialization — This module is a thin re-export layer that delegates all database functionality
architectural refactoring
- service — Chat domain re-export facade for backward compatibility — This module serves as a thin re-export layer for the chat domain, consolidating
architecture — module organization and facade patterns
- init — Facade module exposing shared cross-cutting concerns for the PocketPaw cloud ecosystem — This module serves as the public interface for shared utilities, services, and i
auth domain
- schemas — Pydantic models for authentication request/response validation — This module defines three Pydantic BaseModel classes that standardize the shape
authentication
- core — Enterprise JWT authentication with cookie and bearer transport for FastAPI — This module implements a complete authentication system for PocketPaw using fast
- router — FastAPI authentication endpoints and user profile management — This module exposes HTTP endpoints for user authentication, registration, profil
authorization
- core — Enterprise JWT authentication with cookie and bearer transport for FastAPI — This module implements a complete authentication system for PocketPaw using fast
authorization & access control
- license — Enterprise license validation and feature gating for cloud deployments — This module provides cryptographic validation of signed license keys, caching of
backward compatibility
- service — Chat domain re-export facade for backward compatibility — This module serves as a thin re-export layer for the chat domain, consolidating
chat / messaging
- session — Cloud-tracked chat session document model for pocket-scoped conversations — The session module defines the Session document model that represents individual
chat domain
- chat/init.py — Entry point for chat domain with groups, messages, and WebSocket real-time capabilities — This module serves as the public API gateway for the chat domain, re-exporting t
- service — Chat domain re-export facade for backward compatibility — This module serves as a thin re-export layer for the chat domain, consolidating
chat/collaboration — domain area for group conversations
- group — Multi-user chat channels with AI agent participants — This module defines the data models for chat groups/channels that support multip
cloud storage
- file — Cloud storage metadata document for managing file references — This module defines the
FileObjdocument model that stores metadata about file
collaborative features
- pocket — Data models for Pocket workspaces with widgets, teams, and collaborative agents — This module defines the core document models (Pocket, Widget, WidgetPosition) th
compatibility layer
- db — Backward compatibility facade for cloud database initialization — This module is a thin re-export layer that delegates all database functionality
configuration storage
- agent — Agent configuration and metadata storage for workspace-scoped AI agents — This module defines the data models for storing agent configurations in the OCEA
cross-cutting concerns
- base — Foundational document model with automatic timestamp management for MongoDB persistence — This module provides
TimestampedDocument, a base class that extends Beanie’s O
cross-cutting concerns — auth, errors, events shared across all features
- init — Facade module exposing shared cross-cutting concerns for the PocketPaw cloud ecosystem — This module serves as the public interface for shared utilities, services, and i
data model
- file — Cloud storage metadata document for managing file references — This module defines the
FileObjdocument model that stores metadata about file - schemas — Pydantic request/response models for agent lifecycle and discovery operations — This module defines four Pydantic BaseModel classes that serve as the contract l
- workspace — Data model for organization workspaces in multi-tenant enterprise deployments — This module defines the core data models that represent a workspace: the contain
data model / ORM
- session — Cloud-tracked chat session document model for pocket-scoped conversations — The session module defines the Session document model that represents individual
data model / schema
- pocket — Data models for Pocket workspaces with widgets, teams, and collaborative agents — This module defines the core document models (Pocket, Widget, WidgetPosition) th
data model layer
- agent — Agent configuration and metadata storage for workspace-scoped AI agents — This module defines the data models for storing agent configurations in the OCEA
- base — Foundational document model with automatic timestamp management for MongoDB persistence — This module provides
TimestampedDocument, a base class that extends Beanie’s O
data model — core persistent entity
- group — Multi-user chat channels with AI agent participants — This module defines the data models for chat groups/channels that support multip
data model: ODM document
- invite — Workspace membership invitation document model — The invite module defines the Invite document class that represents pending work
data persistence
- db — MongoDB connection and Beanie ODM lifecycle management for PocketPaw cloud infrastructure — This module provides a centralized, application-level abstraction for managing M
data validation
- schemas — Pydantic request/response contracts for session lifecycle operations — This module defines the HTTP API contracts (request bodies and response payloads
- schemas — Pydantic request/response data models for workspace domain operations — This module defines the contract between the workspace API layer and its consume
- schemas — Request/response data validation for the knowledge base REST API — This module defines Pydantic request/response schemas for the knowledge base dom
dependency injection — fastapi and inversion of control
- init — Facade module exposing shared cross-cutting concerns for the PocketPaw cloud ecosystem — This module serves as the public interface for shared utilities, services, and i
document structure
- pocket — Data models for Pocket workspaces with widgets, teams, and collaborative agents — This module defines the core document models (Pocket, Widget, WidgetPosition) th
domain: workspace access control
- invite — Workspace membership invitation document model — The invite module defines the Invite document class that represents pending work
enterprise cloud agents
- ee.cloud.agents — Package initialization and router export for enterprise cloud agent functionality — This is a minimal package initialization module that serves as the public API en
enterprise cloud platform
- pockets.init — Entry point and public API aggregator for the pockets subsystem — This module serves as the public interface for the enterprise cloud pockets subs
enterprise security
- core — Enterprise JWT authentication with cookie and bearer transport for FastAPI — This module implements a complete authentication system for PocketPaw using fast
file management
- file — Cloud storage metadata document for managing file references — This module defines the
FileObjdocument model that stores metadata about file
foundational infrastructure
- base — Foundational document model with automatic timestamp management for MongoDB persistence — This module provides
TimestampedDocument, a base class that extends Beanie’s O
infrastructure layer
- db — MongoDB connection and Beanie ODM lifecycle management for PocketPaw cloud infrastructure — This module provides a centralized, application-level abstraction for managing M
infrastructure — cloud database
- db — Backward compatibility facade for cloud database initialization — This module is a thin re-export layer that delegates all database functionality
knowledge base domain
- schemas — Request/response data validation for the knowledge base REST API — This module defines Pydantic request/response schemas for the knowledge base dom
licensing & commercialization
- license — Enterprise license validation and feature gating for cloud deployments — This module provides cryptographic validation of signed license keys, caching of
module initialization
- chat/init.py — Entry point for chat domain with groups, messages, and WebSocket real-time capabilities — This module serves as the public API gateway for the chat domain, re-exporting t
multi-tenancy
- workspace — Data model for organization workspaces in multi-tenant enterprise deployments — This module defines the core data models that represent a workspace: the contain
multi-tenancy — workspace scoping and data isolation
- init — Facade module exposing shared cross-cutting concerns for the PocketPaw cloud ecosystem — This module serves as the public interface for shared utilities, services, and i
multi-tenant architecture
- router — FastAPI authentication endpoints and user profile management — This module exposes HTTP endpoints for user authentication, registration, profil
multi-user feature — supports multiple participants with different roles
- group — Multi-user chat channels with AI agent participants — This module defines the data models for chat groups/channels that support multip
package initialization
- ee.cloud.agents — Package initialization and router export for enterprise cloud agent functionality — This is a minimal package initialization module that serves as the public API en
package initialization and namespacing
- pockets.init — Entry point and public API aggregator for the pockets subsystem — This module serves as the public interface for the enterprise cloud pockets subs
pattern: invitation lifecycle
- invite — Workspace membership invitation document model — The invite module defines the Invite document class that represents pending work
real-time messaging infrastructure
- chat/init.py — Entry point for chat domain with groups, messages, and WebSocket real-time capabilities — This module serves as the public API gateway for the chat domain, re-exporting t
request/response contracts
- schemas — Request/response data validation for the knowledge base REST API — This module defines Pydantic request/response schemas for the knowledge base dom
schema definition
- agent — Agent configuration and metadata storage for workspace-scoped AI agents — This module defines the data models for storing agent configurations in the OCEA
- schemas — Pydantic request/response data models for workspace domain operations — This module defines the contract between the workspace API layer and its consume
security & cryptography
- license — Enterprise license validation and feature gating for cloud deployments — This module provides cryptographic validation of signed license keys, caching of
security: token-based invitations
- invite — Workspace membership invitation document model — The invite module defines the Invite document class that represents pending work
service layer
- core — Enterprise JWT authentication with cookie and bearer transport for FastAPI — This module implements a complete authentication system for PocketPaw using fast
- service — Chat domain re-export facade for backward compatibility — This module serves as a thin re-export layer for the chat domain, consolidating
sessions domain
- schemas — Pydantic request/response contracts for session lifecycle operations — This module defines the HTTP API contracts (request bodies and response payloads
system-wide contracts
- schemas — Pydantic models for authentication request/response validation — This module defines three Pydantic BaseModel classes that standardize the shape
temporal auditing
- base — Foundational document model with automatic timestamp management for MongoDB persistence — This module provides
TimestampedDocument, a base class that extends Beanie’s O
workspace and collaboration domain
- pockets.init — Entry point and public API aggregator for the pockets subsystem — This module serves as the public interface for the enterprise cloud pockets subs
workspace domain
- schemas — Pydantic request/response data models for workspace domain operations — This module defines the contract between the workspace API layer and its consume
workspace management
- pocket — Data models for Pocket workspaces with widgets, teams, and collaborative agents — This module defines the core document models (Pocket, Widget, WidgetPosition) th
- session — Cloud-tracked chat session document model for pocket-scoped conversations — The session module defines the Session document model that represents individual
- workspace — Data model for organization workspaces in multi-tenant enterprise deployments — This module defines the core data models that represent a workspace: the contain
Was this page helpful?