DeepDoc Client Action
Integrates with DeepDoc OCR and document parsing services to ingest documents into a vector store
DeepDoc Client Action
The DeepDoc Client Action interfaces with the DeepDoc service for document processing, chunking, and metadata extraction. It allows users to upload documents or document URLs in batches for various formats (PDF, DOCX, Excel, PPT, TXT), facilitating asynchronous document processing and ingestion into a configured vector store.
This package is defined as a singleton action, requiring the Jivas library (version 2.0.0 or higher) and a properly configured vector_store_action. It also requires the Jivas-modified DeepDoc service.
Package Information
- Name:
jivas/deepdoc_client_action - Author: V75 Inc.
- Architype:
DeepDocStoreAction
Meta Information
- Title: DeepDoc Store Action
- Group: core
- Type: action
Configuration
- Singleton: true
Dependencies
- Jivas:
^2.0.0
How to Configure
This action supports configuration either via environment variables or directly from within the action application settings.
Configuration Options
| Variable Name | Description | Default Value | Required |
|---|---|---|---|
DEEPDOC_API_URL |
API endpoint URL of your DeepDoc service | http://localhost:8001 |
Yes |
DEEPDOC_API_KEY |
Your DeepDoc API authentication token | api-key (replace with secure value) |
Yes |
JIVAS_BASE_URL |
Base URL for your Jivas instance; required for the deepdoc callback to function | http://localhost:8000 | Yes |
VECTOR_STORE_ACTION |
Action used for storing vector data | TypesenseVectorStoreAction |
Yes |
Option 1: Using Environment Variables
You can configure these values as environment variables so they are accessible to your runtime environment.
Linux/MacOS (.bashrc or shell configuration):
export DEEPDOC_API_URL="https://your-custom-deepdoc-url.com"
export DEEPDOC_API_KEY="your-secure-api-key"
export JIVAS_BASE_URL="https://your-jivas-base-url.com"
Docker (docker-compose.yml):
environment:
DEEPDOC_API_URL: "https://your-custom-deepdoc-url.com"
DEEPDOC_API_KEY: "your-secure-api-key"
JIVAS_BASE_URL: "https://your-jivas-base-url.com"
Option 2: Using the Action App’s Config
Alternatively, you can configure these variables within the action app's settings interface in the JIVAS manager. This is useful if you prefer not to use environment variables or want easy adjustments through the GUI.
From within the action's configuration page:
- Navigate to your JIVAS Manangr Dashboard.
- Find and select DeepDoc Client Action under Actions.
- Enter the required configuration values (such as
api_url,api_key, andvector_store_action) into their respective configuration fields. - Save the configuration once complete.
Note: Configuration values set directly within the action app override those provided via environment variables.
After adjusting settings, restart your service or action to apply your changes.
📖 Best Practices
- Validate your API keys and model parameters thoroughly before deployment.
- Test pipelines extensively in staging environments before promoting to production.
🔰 Contributing
- 🐛 Report Issues: Submit reports for bugs identified or feature requests.
- 💡 Submit Pull Requests: Review open PRs and submit your implementations.
Contributing Guidelines
- Fork the repository using GitHub’s fork button.
- Clone your fork locally:
git clone https://github.com/YOUR_USERNAME/deepdoc_store_action - Create a new descriptive branch:
git checkout -b feature-xyz - Implement your changes and ensure testing.
- Commit your changes clearly describing updates:
git commit -m 'feat: add XYZ feature' - Push changes back to your branch:
git push origin feature-xyz - Submit a pull request detailing your changes clearly for review.
Contributor Graph
🎗 License
This project is licensed under the Apache License 2.0. See the LICENSE file for additional licensing information.
Install
jvcli download action jivas/deepdoc_client_action