Files
fil/templates/readme/partials/quick_start.md.jinja
Henrik Jess Nielsen b4c07d3693
All checks were successful
Deploy fil (kreuzberg) / deploy (push) Successful in 49s
Nomad changes
2026-06-01 23:40:55 +02:00

78 lines
2.2 KiB
Django/Jinja

### Basic Extraction
Extract text, metadata, and structure from any supported document format:
{{ snippets.basic_extraction | include_snippet(language) }}
### Common Use Cases
#### Extract with Custom Configuration
Most use cases benefit from configuration to control extraction behavior:
{% if snippets.ocr_configuration %}
**With OCR (for scanned documents):**
{{ snippets.ocr_configuration | include_snippet(language) }}
{% endif %}
#### Table Extraction
{% if snippets.table_extraction %}
{{ snippets.table_extraction | include_snippet(language) }}
{% else %}
See [Configuration Guide](https://docs.kreuzberg.dev/guides/configuration/) for table extraction options.
{% endif %}
#### Processing Multiple Files
{% if snippets.batch_processing %}
{{ snippets.batch_processing | include_snippet(language) }}
{% endif %}
{% if snippets.async_extraction %}
#### Async Processing
For non-blocking document processing:
{{ snippets.async_extraction | include_snippet(language) }}
{% endif %}
{% if snippets.config_discovery %}
#### Configuration Discovery
{{ snippets.config_discovery | include_snippet(language) }}
{% endif %}
{% if snippets.worker_pool %}
#### Worker Thread Pool
{{ snippets.worker_pool | include_snippet(language) }}
**Performance Benefits:**
- **Parallel Processing**: Multiple documents extracted simultaneously
- **CPU Utilization**: Maximizes multi-core CPU usage for large batches
- **Queue Management**: Automatically distributes work across available workers
- **Resource Control**: Prevents thread exhaustion with configurable pool size
**Best Practices:**
- Use worker pools for batches of 10+ documents
- Set pool size to number of CPU cores (default behavior)
- Always close pools with `closeWorkerPool()` to prevent resource leaks
- Reuse pools across multiple batch operations for efficiency
{% endif %}
### Next Steps
- **[Installation Guide](https://docs.kreuzberg.dev/getting-started/installation/)** - Platform-specific setup
- **[API Documentation](https://docs.kreuzberg.dev/reference/api-python/)** - Complete API reference
- **[Examples & Guides](https://docs.kreuzberg.dev/)** - Full code examples and usage guides
- **[Configuration Guide](https://docs.kreuzberg.dev/guides/configuration/)** - Advanced configuration options