User Guide

This section provides detailed guides for using kanoa in various scenarios.

• Getting Started with Gemini
  • Prerequisites
  • Free Tier Overview
  • Step 1: Get Your API Key
  • Step 2: Configure Authentication
  • Step 3: Your First Interpretation
  • Next Steps
  • Troubleshooting
• Getting Started with Claude
  • Prerequisites
  • Step 1: Get Your API Key
  • Step 2: Configure Authentication
  • Step 3: Your First Interpretation
  • Next Steps
  • Troubleshooting
  • Why Choose Claude?
• Getting Started with Local Inference
  • Prerequisites
  • Quick Start
  • Hardware Requirements
  • Supported Models
  • Next Steps
  • Troubleshooting
• Getting Started with OpenAI
  • OpenAI API
  • Azure OpenAI
  • Model Selection
  • Next Steps
  • Troubleshooting
• Backends
  • Gemini (gemini)
  • Claude (claude)
  • vLLM (vllm)
  • OpenAI (openai)
  • Enterprise Considerations
• Knowledge Bases
  • Quick Start
  • Supported File Types
  • Direct Content
  • Examples
  • Best Practices
  • Reloading
  • Migration from v0.1.x
• Logging
  • Quick Start
  • Log Levels
  • User Log Functions
  • Custom Log Streams
  • Logging Rich Objects
  • Configuration Options
  • Console Mode
  • Per-Cell Behavior
  • Disabling Logging
• Cost Management
  • Overview
  • Quick Start
  • Backend-Specific Counters
  • Threshold Configuration
  • Usage Patterns
  • Interactive Approval
  • Integration with Backends
  • Best Practices
  • API Reference
• kanoa Integration Guide
  • Quick Start
  • Recommended: Create a Domain-Specific Wrapper
  • Knowledge Base Setup
  • Knowledge Base Strategies
  • Advanced RAG Engine Configuration
  • Complete RAG Engine Example
  • Advanced Configuration
  • Testing Your Integration
  • Best Practices
  • Troubleshooting
  • Example: Complete Integration
  • Resources & References
• Authentication & API Key Management
  • Quick Setup
  • Backend-Specific Authentication
  • Production Deployment
  • Security Best Practices
  • Troubleshooting
  • For Contributors
  • References

Overview

kanoa is designed to be flexible and work across multiple use cases:

• Research Notebooks: Interpret plots and results inline

• Production Pipelines: Automated analysis with cost tracking

• Multi-Backend: Switch between Gemini 3 Pro, Claude Sonnet 4.5, and local models

• Knowledge Grounding: Leverage your project’s documentation and literature