Cloud V2 for Developers
- API Overview
- Basic Topics
- API PaaS Tutorials
- Building Custom Search Integrations Using Coveo Cloud PaaS
- Search API
- Usage Analytics Write API
- Usage Analytics Read API
- Push API
- Activity API
- Authorization Server API
- Field API
- Index API
- Notification API
- Platform API
- Security Cache API
- Source API
- Source Logs API
- Indexing Pipeline Customization Tools Overview
Indexing Pipeline Extensions
- Document Object Python API Reference
- Condition Syntax Reference
- Python Modules Available to Extensions
- Extension Parameters
- Extension ActionOnError
- Supported Character Sets
- Extension Script Samples
- Creating an Extension With the API
- Logging Messages From an Extension
- Passing Parameters to Extension Scripts
- Applying an Extension to a Source
- Testing Strategies and Good Practices
- Coveo On-Premises Crawling Module
- Coveo on Elasticsearch
- Coveo Cloud V2 - API Reference
Coveo Cloud V2 Indexing Pipeline Extensions
The indexing pipeline extension (IPE) feature provides a way to execute Python conversion scripts in a securely isolated non-persistent container, allowing developers to customize how items get indexed. Extension scripts can be executed at two different stages of the indexing pipeline: pre-conversion and post-conversion.
You can manage your indexing pipeline extensions from the Coveo Cloud administration console Extensions page and get more information on indexing pipeline extensions from the administration console documentation (see Adding and Managing Extensions).
You can execute an indexing pipeline extension for every item of one or more sources of your organization using the Coveo Cloud APIs:
- In the administration console API Keys page, add an API key to which you grant the privilege to edit extensions (i.e., the Edit access level on the Extensions domain) (see Adding and Managing API Keys, Privilege Management, and Extensions Domain).
- Write your extension script using the
documentobject (see Document Object Python API Reference).
- Create your extension (see Creating an Indexing Pipeline Extension With the API).
- Add your script to your extension.
- Apply your extension to your source(s) (see Applying an Indexing Pipeline Extension to a Source with the API).
- Rebuild your source(s) to make your extension effective.
- Validate that your changes perform as expected.