# Sophra

## Docs

- [Request Server Key](https://documentation.sophra.org/api-reference/administration/request-server-key.md)
- [Assign to A/B Test](https://documentation.sophra.org/api-reference/cortex->-ab-testing/assign-to-ab-test.md)
- [Create A/B Test](https://documentation.sophra.org/api-reference/cortex->-ab-testing/create-ab-test.md)
- [Get Analytics Report](https://documentation.sophra.org/api-reference/cortex->-analytics/get-analytics-report.md)
- [Log Search Analytics](https://documentation.sophra.org/api-reference/cortex->-analytics/log-search-analytics.md)
- [Create Document](https://documentation.sophra.org/api-reference/cortex->-document-operations/create-document.md)
- [Get Document](https://documentation.sophra.org/api-reference/cortex->-document-operations/get-document.md)
- [Update Document](https://documentation.sophra.org/api-reference/cortex->-document-operations/update-document.md)
- [Vectorize Document](https://documentation.sophra.org/api-reference/cortex->-document-operations/vectorize-document.md)
- [Verify Document](https://documentation.sophra.org/api-reference/cortex->-document-operations/verify-document.md)
- [Get Feedback Requests](https://documentation.sophra.org/api-reference/cortex->-feedback/get-feedback-requests.md)
- [Record Search Feedback](https://documentation.sophra.org/api-reference/cortex->-feedback/record-search-feedback.md)
- [Create Index](https://documentation.sophra.org/api-reference/cortex->-index-management/create-index.md)
- [Get Indices](https://documentation.sophra.org/api-reference/cortex->-index-management/get-indices.md)
- [Get API Metrics](https://documentation.sophra.org/api-reference/cortex->-metrics/get-api-metrics.md): Returns Prometheus-formatted metrics for all API endpoints. Tracks request counts, durations, sizes, errors, and active requests across normalized endpoint patterns. Metrics are exposed with appropriate labels for method, endpoint, and status.
- [Get Metrics](https://documentation.sophra.org/api-reference/cortex->-metrics/get-metrics.md)
- [Hybrid Search](https://documentation.sophra.org/api-reference/cortex->-search-operations/hybrid-search.md)
- [Create Session](https://documentation.sophra.org/api-reference/cortex->-session-management/create-session.md)
- [Get Session](https://documentation.sophra.org/api-reference/cortex->-session-management/get-session.md)
- [Get Session Analytics](https://documentation.sophra.org/api-reference/cortex->-session-management/get-session-analytics.md)
- [Health Check](https://documentation.sophra.org/api-reference/cortex->-system-health/health-check.md): # Health Check Endpoint
- [Get cortexdocuments](https://documentation.sophra.org/api-reference/get-cortexdocuments.md)
- [Get cortexsessions analytics](https://documentation.sophra.org/api-reference/get-cortexsessions-analytics.md)
- [Activate Experiment](https://documentation.sophra.org/api-reference/nous->-ab-testing/activate-experiment.md)
- [Create Experiment](https://documentation.sophra.org/api-reference/nous->-ab-testing/create-experiment.md)
- [Deactivate Experiment](https://documentation.sophra.org/api-reference/nous->-ab-testing/deactivate-experiment.md)
- [Get Experiments](https://documentation.sophra.org/api-reference/nous->-ab-testing/get-experiments.md)
- [Submit Results](https://documentation.sophra.org/api-reference/nous->-ab-testing/submit-results.md)
- [Apply Rules](https://documentation.sophra.org/api-reference/nous->-adaptation/apply-rules.md)
- [Create Rules](https://documentation.sophra.org/api-reference/nous->-adaptation/create-rules.md)
- [Get Rules](https://documentation.sophra.org/api-reference/nous->-adaptation/get-rules.md)
- [Suggest New Rule](https://documentation.sophra.org/api-reference/nous->-adaptation/suggest-new-rule.md): Generated from cURL: curl -X POST http://localhost:3000/api/adapt/suggest \
   -H "Content-Type: application/json" \
   -d '{
     "queryHash": "hash_of_search_query",
     "patterns": {
       "positivePatterns": ["good_result_pattern"],
       "negativePatterns": ["bad_result_pattern"],
       "ne…
- [Check Health](https://documentation.sophra.org/api-reference/nous->-health/check-health.md)
- [Get Feedback Pattern Analysis](https://documentation.sophra.org/api-reference/nous->-learning->-feedback/get-feedback-pattern-analysis.md)
- [Get Recent Feedback](https://documentation.sophra.org/api-reference/nous->-learning->-feedback/get-recent-feedback.md)
- [Submit Feedback](https://documentation.sophra.org/api-reference/nous->-learning->-feedback/submit-feedback.md)
- [Get Learning Events](https://documentation.sophra.org/api-reference/nous->-learning->-metrics-and-events/get-learning-events.md)
- [Get Learning Metrics](https://documentation.sophra.org/api-reference/nous->-learning->-metrics-and-events/get-learning-metrics.md)
- [Create Model](https://documentation.sophra.org/api-reference/nous->-learning->-models/create-model.md)
- [Get Model by ID](https://documentation.sophra.org/api-reference/nous->-learning->-models/get-model-by-id.md)
- [Sync Model State](https://documentation.sophra.org/api-reference/nous->-learning->-models/sync-model-state.md)
- [Search Patterns](https://documentation.sophra.org/api-reference/nous->-learning->-search-patterns/search-patterns.md)
- [Search Patterns](https://documentation.sophra.org/api-reference/nous->-learning->-search-patterns/search-patterns-1.md)
- [Create Signal](https://documentation.sophra.org/api-reference/nous->-signals/create-signal.md)
- [Get Signals](https://documentation.sophra.org/api-reference/nous->-signals/get-signals.md)
- [Observe Signals](https://documentation.sophra.org/api-reference/nous->-signals/observe-signals.md)
- [Observe Signals](https://documentation.sophra.org/api-reference/nous->-signals/observe-signals-1.md)
- [Record Signal Event](https://documentation.sophra.org/api-reference/nous->-signals/record-signal-event.md)
- [Put cortexdocuments](https://documentation.sophra.org/api-reference/put-cortexdocuments.md)
- [OpenAI Client for Fine-Tuning and Model Management](https://documentation.sophra.org/core/clients/openai.md): A TypeScript client for interacting with OpenAI's fine-tuning API, optimized for Sophra's machine learning pipeline.
- [Configuration Management System](https://documentation.sophra.org/core/config/index.md): A robust configuration management system for the Sophra data synchronization and management layer
- [Sophra Configuration Management](https://documentation.sophra.org/core/config/settings.md): A robust, type-safe configuration management system for the Sophra data synchronization platform
- [Configuration Type Definitions for Sophra](https://documentation.sophra.org/core/config/types.md): Comprehensive type definitions and schemas for Sophra's configuration system
- [Model Registry and Configuration Management](https://documentation.sophra.org/core/models/base.md): Core component for managing ML model configurations and versioning in Sophra's adaptive learning system
- [Model Configuration and Management API](https://documentation.sophra.org/core/models/models/route.md): RESTful API for managing machine learning model configurations and versions in the Sophra system
- [Model Synchronization API](https://documentation.sophra.org/core/models/models/sync/route.md): Advanced API endpoint for synchronizing machine learning model states and metrics in the Sophra system
- [Registry](https://documentation.sophra.org/core/registry/index.md)
- [Metadata Management System](https://documentation.sophra.org/core/registry/metadata.md): A robust metadata schema validation and storage system for Sophra's data management layer
- [Store](https://documentation.sophra.org/core/registry/store.md)
- [Version Management System for Sophra](https://documentation.sophra.org/core/registry/version.md): A robust versioning system for managing data entry lifecycles in the Sophra ecosystem
- [Advanced Search Types for Sophra](https://documentation.sophra.org/core/types/search.md): Comprehensive TypeScript interfaces for Sophra's sophisticated search capabilities
- [Sophra Services Interface](https://documentation.sophra.org/core/types/services.md): Comprehensive TypeScript interface defining core services for the Sophra data synchronization and management system
- [Adaptation Types for Sophra's Intelligent Data Processing](https://documentation.sophra.org/core/types/types/adaptation.md): Core type definitions for Sophra's adaptive rule system, enabling dynamic data processing and system behavior modification.
- [Event Types and Processing for Sophra](https://documentation.sophra.org/core/types/types/events.md): Core event definitions and processing interfaces for the Sophra data synchronization system
- [Types](https://documentation.sophra.org/core/types/types/index.md)
- [Learning Event System for Adaptive Data Processing](https://documentation.sophra.org/core/types/types/learning.md): A sophisticated event-driven learning framework for Sophra's adaptive data processing and optimization pipeline.
- [Model Types and Configurations for Sophra's Machine Learning Pipeline](https://documentation.sophra.org/core/types/types/models.md): Comprehensive type definitions and interfaces for Sophra's adaptive learning system models
- [Signal Processing and Analysis System](https://documentation.sophra.org/core/types/types/signals.md): Advanced signal handling and processing infrastructure for the Sophra data intelligence platform
- [Bulk Document Ingestion API](https://documentation.sophra.org/document-and-search-operations/documents/bulk/route.md): High-performance API endpoint for batch processing and indexing of documents in Sophra's Elasticsearch cluster
- [Service](https://documentation.sophra.org/document-and-search-operations/documents/documents/service.md)
- [Cortex Document API Route](https://documentation.sophra.org/document-and-search-operations/documents/route.md): High-performance API route for document ingestion and processing in the Sophra System
- [Document Verification API Route](https://documentation.sophra.org/document-and-search-operations/documents/verify/route.md): Next.js API route for verifying document existence in Elasticsearch indices
- [Search Patterns Learning API](https://documentation.sophra.org/document-and-search-operations/search-patterns/route.md): Advanced API for analyzing and storing search patterns in Sophra's adaptive learning system
- [Cortex Search API Route](https://documentation.sophra.org/document-and-search-operations/search/route.md): Advanced search endpoint leveraging Elasticsearch for text, vector, and hybrid queries with faceting and event tracking
- [AB Test Assignment API Route](https://documentation.sophra.org/experimentation/ab-test/assign/route.md): Next.js API route for assigning variants in A/B tests with comprehensive error handling and metrics tracking
- [A/B Test Creation API Route](https://documentation.sophra.org/experimentation/ab-test/create/route.md): Next.js API route for creating A/B tests in the Sophra System's Cortex module
- [A/B Testing Service for Sophra](https://documentation.sophra.org/experimentation/ab-testing/ab-testing/services.md): Advanced A/B testing implementation with real-time metrics and statistical analysis
- [A/B Testing Experiment Activation API](https://documentation.sophra.org/experimentation/ab-testing/experiments/activate/route.md): RESTful endpoint for activating A/B testing experiments in the Sophra System
- [A/B Testing Experiment Management API](https://documentation.sophra.org/experimentation/ab-testing/experiments/route.md): RESTful API for managing A/B testing experiments in the Sophra System
- [A/B Testing Results API](https://documentation.sophra.org/experimentation/ab-testing/results/route.md): High-performance API for recording and retrieving A/B test metrics in the Sophra System
- [Adaptation Rule Application API](https://documentation.sophra.org/experimentation/adapt/apply/route.md): A Next.js API route for applying adaptive rules in the Sophra system
- [Adaptation Rules API Route](https://documentation.sophra.org/experimentation/adapt/rules/route.md): Next.js API route for managing adaptive learning rules in the Sophra system
- [Adaptation Suggestion API Route](https://documentation.sophra.org/experimentation/adapt/suggest/route.md): Next.js API route for processing and storing adaptation suggestions in the Sophra system
- [Real-Time Learning Engine](https://documentation.sophra.org/experimentation/engine/real-time-learner.md): Adaptive search optimization through continuous pattern analysis and strategy validation
- [Nous Engine Service](https://documentation.sophra.org/experimentation/engine/service.md): Core engine for adaptive learning and optimization in the Sophra system
- [Nous Engine Types and Interfaces](https://documentation.sophra.org/experimentation/engine/types.md): Core type definitions and interfaces for the Sophra Nous Engine, powering adaptive learning and optimization strategies.
- [Cortex Feedback API Route](https://documentation.sophra.org/experimentation/feedback/feedback/route.md): Advanced feedback processing and analytics endpoint for the Sophra System
- [Feedback Processing API Route](https://documentation.sophra.org/experimentation/feedback/route.md): Advanced feedback handling and analytics for Sophra's adaptive learning system
- [Introduction](https://documentation.sophra.org/get-started/introduction.md): Welcome to the Sophra documentation
- [Quickstart](https://documentation.sophra.org/get-started/quickstart.md): Get started with Sophra in minutes
- [Admin Authentication Middleware](https://documentation.sophra.org/infrastructure/admin.middleware.md): Robust JWT-based authentication and authorization middleware for admin API routes in the Sophra system
- [Admin Permissions Module](https://documentation.sophra.org/infrastructure/admin/permissions.md): A robust permission management system for Sophra's admin API endpoints
- [Client](https://documentation.sophra.org/infrastructure/core/client.md)
- [Service factory](https://documentation.sophra.org/infrastructure/core/service-factory.md)
- [Core Service Architecture](https://documentation.sophra.org/infrastructure/core/services.md): Foundational service layer for Sophra's microservices ecosystem
- [Data Synchronization Service](https://documentation.sophra.org/infrastructure/core/sync-service.md): A robust service for managing data consistency across Elasticsearch, PostgreSQL, and Redis in the Sophra system.
- [Validation service](https://documentation.sophra.org/infrastructure/core/validation-service.md)
- [Client](https://documentation.sophra.org/infrastructure/elasticsearch/client.md)
- [Elasticsearch Configuration Generator](https://documentation.sophra.org/infrastructure/elasticsearch/core.md): A robust utility for creating secure Elasticsearch configurations in the Sophra system
- [Elasticsearch Index Initialization](https://documentation.sophra.org/infrastructure/elasticsearch/init.md): A robust module for setting up and managing Elasticsearch indices in the Sophra system
- [Elasticsearch Query Builder](https://documentation.sophra.org/infrastructure/elasticsearch/query-builders.md): Advanced query construction for Sophra's Elasticsearch integration
- [Services](https://documentation.sophra.org/infrastructure/elasticsearch/services.md)
- [Elasticsearch Types and Query Interfaces](https://documentation.sophra.org/infrastructure/elasticsearch/types.md): Core type definitions and query interfaces for Elasticsearch integration in Sophra
- [Cortex Engine Health API](https://documentation.sophra.org/infrastructure/engine/health/route.md): A robust health check endpoint for the Sophra Cortex Engine, providing detailed operational metrics and system status.
- [Admin Middleware for API Key Management](https://documentation.sophra.org/infrastructure/keys/admin.middleware.md): A Next.js middleware for validating admin tokens in API requests
- [API Key Management System](https://documentation.sophra.org/infrastructure/keys/route.md): A robust API key management system for Sophra's authentication and authorization infrastructure
- [API Middleware for Authentication and Rate Limiting](https://documentation.sophra.org/infrastructure/middleware.md): A Next.js middleware component for API key validation, rate limiting, and usage tracking
- [Cortex Error Handler Middleware](https://documentation.sophra.org/infrastructure/middleware/error-handler.md): A robust error handling middleware for the Sophra System's Cortex module
- [PostgreSQL Data Service](https://documentation.sophra.org/infrastructure/postgres/services.md): A robust PostgreSQL integration service for Sophra's data management layer
- [Client](https://documentation.sophra.org/infrastructure/redis/client.md)
- [Services](https://documentation.sophra.org/infrastructure/redis/services.md)
- [SessionCacheService - Redis-Powered Conversation Memory](https://documentation.sophra.org/infrastructure/redis/session-cache.md): A high-performance, Redis-backed session and conversation management service for the Sophra System
- [Redis Service Types and Configurations](https://documentation.sophra.org/infrastructure/redis/types.md): Core type definitions and configurations for Sophra's Redis caching layer
- [Circuit breaker](https://documentation.sophra.org/infrastructure/utils/circuit-breaker.md)
- [Error Handling Utilities](https://documentation.sophra.org/infrastructure/utils/errors.md): Advanced error management and formatting for the Sophra System
- [Rate limit](https://documentation.sophra.org/infrastructure/utils/rate-limit.md)
- [Request queue](https://documentation.sophra.org/infrastructure/utils/request-queue.md)
- [Service manager](https://documentation.sophra.org/infrastructure/utils/service-manager.md)
- [Service Manager for Nous Observe Module](https://documentation.sophra.org/infrastructure/utils/utils/service-manager.md): A singleton class managing service lifecycle and dependencies for the Sophra system's Nous Observe module.
- [Signal Response Utility](https://documentation.sophra.org/infrastructure/utils/utils/signal-response.md): A robust Next.js response generator for standardized API outputs in the Sophra system
- [Threading](https://documentation.sophra.org/infrastructure/utils/utils/threading.md)
- [Validation Utilities for Sophra](https://documentation.sophra.org/infrastructure/utils/validation.md): Advanced request validation and schema management for the Sophra data synchronization system
- [Health Check API Route](https://documentation.sophra.org/observability/health/health/route.md): A robust health check endpoint for the Sophra system, integrating OpenAI connectivity validation
- [Health Check API Route](https://documentation.sophra.org/observability/health/route.md): A robust health check endpoint for monitoring Sophra system components
- [Edge metrics adapter](https://documentation.sophra.org/observability/monitoring/edge-metrics-adapter.md)
- [Sophra Metrics Service](https://documentation.sophra.org/observability/monitoring/metrics.md): A comprehensive metrics collection and reporting system for the Sophra platform
- [Metrics Configuration Module](https://documentation.sophra.org/observability/monitoring/metrics-config.md): Advanced monitoring configuration for Sophra's observability pipeline
- [Signal Observation API Route](https://documentation.sophra.org/observability/signals/observe/route.md): Next.js API route for observing and analyzing signal data in the Sophra system
- [Signal Processing API Route](https://documentation.sophra.org/observability/signals/process/route.md): Advanced signal processing and management endpoint for the Sophra System
- [Nous Signals API Route](https://documentation.sophra.org/observability/signals/route.md): RESTful API endpoint for managing and querying Sophra's signal processing system
- [Analytics Service for Sophra](https://documentation.sophra.org/reporting-and-analytics/analytics/analytics/service.md): A robust analytics engine for tracking and analyzing search events in the Sophra system
- [Analytics Types for Sophra's Cortex System](https://documentation.sophra.org/reporting-and-analytics/analytics/analytics/types.md): Core type definitions for Sophra's analytics engine, providing structured data models for metrics, trends, insights, and reporting.
- [Analytics Report Generation API](https://documentation.sophra.org/reporting-and-analytics/analytics/reports/route.md): A Next.js API route for generating and retrieving analytics reports within the Sophra system
- [Search Analytics API Route](https://documentation.sophra.org/reporting-and-analytics/analytics/search/route.md): Next.js API route for logging and retrieving search analytics in the Sophra system
- [Learning Events API Route](https://documentation.sophra.org/reporting-and-analytics/events/route.md): Next.js API route for retrieving and managing learning events in the Sophra system
- [Learning Metrics API Route](https://documentation.sophra.org/reporting-and-analytics/metrics/metrics/route.md): Advanced metrics retrieval endpoint for Sophra's adaptive learning system
- [Cortex Metrics API Route](https://documentation.sophra.org/reporting-and-analytics/metrics/route.md): Next.js API route for retrieving Prometheus-formatted metrics from the Sophra system
- [Alert thresholds](https://documentation.sophra.org/reporting-and-analytics/reporting/alert-thresholds.md)
- [Report Distribution Service](https://documentation.sophra.org/reporting-and-analytics/reporting/distribution.md): A sophisticated service for distributing analytics reports across various channels in the Sophra system.
- [Recommendations](https://documentation.sophra.org/reporting-and-analytics/reporting/recommendations.md)
- [Scheduler](https://documentation.sophra.org/reporting-and-analytics/reporting/scheduler.md)
- [Service](https://documentation.sophra.org/reporting-and-analytics/reporting/service.md)
- [Cortex Reporting Types](https://documentation.sophra.org/reporting-and-analytics/reporting/types.md): Core type definitions for Sophra's intelligent reporting and alerting system
- [Cortex Session Management API](https://documentation.sophra.org/reporting-and-analytics/sessions/route.md): RESTful API for managing user sessions in the Sophra System's Cortex module

## OpenAPI Specs

- [definition](https://documentation.sophra.org/docs/definition.yml)
- [openapi](https://documentation.sophra.org/api-reference/openapi.json)

## Optional

- [GitHub](https://github.com/sophra-org/sophra)