Examples
Overview
Use cases for Docling for IBM watsonx
Docling for IBM watsonx provides Docling's ability to convert documents by delegating the processing resources necessary on an external server.
To use Docling for watsonx, there are two recommended methods to converting a document:
- Making HTTP requests to API endpoints
- Using the Python SDK (recommended)
Setup
Regardless of which method you decide on, you must have a service URL and an API key, personal to your Docling for IBM watsonx account. Please refer to the Quickstart guide for guidance on how to access these.
All examples will refer to these placeholders
{DOCLING_SERVICE_URL}- Your Service URL from the Docling for IBM watsonx client.{DOCLING_API_KEY}- Your API key from the Docling for IBM watsonx client.{TASK_ID}- The task ID returned from conversion requests (API endpoint only)
Store your credentials securely using environment variables:
export DOCLING_SERVICE_URL="${DOCLING_SERVICE_URL}"
export DOCLING_API_KEY="${DOCLING_API_KEY}"Available Examples
- Basic Conversion: Get started with your first document conversion
- Batch Conversion: Process multiple documents efficiently in a single request
- Custom Conversion: Customize the conversion process to meet your specific needs
- Specific Extraction: Extract targeted content from your documents