logo
Assistants
Initializing search
    • Getting Started
    • User Guide
    • Command Line Tools
    • Working with Python
    • Platform Reference
    • Extension Packs
    • Models
    • Deployment
      • Introduction
      • Use Cases
        • Approach
        • Documents
        • Features
        • Tags
      • Getting Started
      • Getting Started
      • Reference
      • Getting Started
        • Creating a Document
        • Connectors
        • Working with Content
        • Selectors
        • Introduction
        • Organizations
        • Projects
        • Assistants
      • Overview
      • Components
      • API Conventions
        • Introducing Projects
        • Introducing Assistants
        • Configuration
        • Overview
        • Document Stores
        • Data Stores
        • Model Stores
        • Overview
        • Overview
        • Working with Labels
        • Overview
        • Taxons
        • Data Types
        • Overview
        • Data Form Types
        • Working with Options
        • Result Filtering
      • Introduction
        • Getting Started
            • Document Label
            • Remove All Labels
            • Delete Model Training
            • Run Python Code as a Step
            • Node Rollup Transformer
            • Pattern-Based Node Tagger
            • Make Training Active
            • Make Training Active
            • Apply labels from related labels
            • Processing
            • Training/Testing
            • Extracted Data
            • Empty Project
            • Data Structure
            • SFTP Bulk Publishing Assistant
            • SFTP Publishing Assistant
            • AWS S3 Publish Assistant
            • Snowflake Publish Assistant
            • Azure Blob Publisher Assistant
            • Pipeline Assistant
            • Zip File Assistant
            • Python Script Assistant
            • Scheduled Python Script Assistant
            • Core
        • Getting Started
            • Extract and index spatial content
            • Labelled Template Table Tagger
            • Analyze Spatial Layout and Transform Nodes
            • PDF Parser
            • Pattern-Based Table Tagger
            • Multiple Table Tagger
            • Selector Based Table Tagger
            • Automatic Table Tagger
            • Automatic Form Tagger
            • Apply Data Helpers
            • Labelled Template Form Tagger
            • PDF Project
            • PDF Assistant
            • PDF Assistant
            • File Conversion Assistant
            • Spatial
        • Getting Started
            • Base Model Runtime Inference Action
            • Base Model Runtime Training Action
            • OCR Model Runtime Inference Action
            • OCR Model Runtime Training Action
            • Transformers Model Runtime Inference Action
            • Transformers Model Runtime Training Action
            • Base Model Runtime
            • OCR Model Runtime
            • Transformers Model Runtime
            • Model Runtime
            • OCR Model Runtime
            • Transformers Model Runtime
        • Getting Started
            • Automatic Excel Table Tagger
            • Labelled Excel Table Tagger
            • Excel File Parser
            • Excel Project
            • Excel Assistant
            • Excel Assistant
            • Workbook
        • Getting Started
            • AWS Textract
            • Azure Custom Form Recognizer
            • Azure Document Analysis
            • Azure Form Recognizer
            • Azure General Document
            • Azure Invoice Recognizer
            • Azure Read API
            • Azure Receipt Recognizer
            • OpenAI Answers
            • OCR with Textract
            • Invoice Processing with Azure
            • OCR with Azure
            • Receipt Processing with Azure
            • Contracts with Google Document AI
            • Driver Licenses with Google Cloud
            • Forms & Tables
        • Installation
        • Helm Chart

    Another important concept to understand is the use of Assistants.

    Assistants are based on an Assistant Definition, though you create an instance of the assistant on a specific project.

    The assistant is responsible for handling events that occur within the scope of the project and its resources. It will then return pipelines that can be processed to effect change in the project.

    In [1]:
    from kodexa.platform import KodexaClient
    
    client = KodexaClient()
    
    client.organizations.list(query='Philip').to_df()
    philips_organization = client.organizations.find_by_slug('philips-world')
    philips_organization.projects.list().to_df()
    
    Out[1]:
    id uuid created_on updated_on organization name description metadata show_tasks show_thumbnails ... show_search show_tooltips_on_labeling has_image project_template_ref memory document_statuses attribute_statuses status owner client
    0 6d33f7b9-f072-4593-988e-15865999e9b5 06fe6eb8a18b4ad4a9369896a0ee8f03 2022-12-20 17:27:16.462000+00:00 2022-12-20 17:27:16.462000+00:00 {'id': 'f89d51f5-4905-4bd9-ab06-6ba61f3e7891',... BARRO54812A A project for extracting data from invoices None False True ... False False False kodexa/azure-invoice-project-template:1.0.0 {'recent_filters': {}} [] [] None None <kodexa.platform.client.KodexaClient object at...
    1 4dce973d-0420-413f-9027-1d83606d9085 f1f240ac7fb74ce09a7094583cfd5dcf 2022-12-14 00:48:28.868000+00:00 2022-12-14 00:48:28.868000+00:00 {'id': 'f89d51f5-4905-4bd9-ab06-6ba61f3e7891',... Dae Similar Formats A basic project outline with process and train... None False True ... False False False kodexa/empty-project:6.0.0-3594945030 {'recent_filters': {}} [] [] None None <kodexa.platform.client.KodexaClient object at...

    2 rows × 22 columns

    We can find a project by its name or ID, then we will be able to work with the project endpoint

    In [2]:
    my_project = philips_organization.projects.find_by_name('Dae Similar Formats')
    
    my_project.assistants.list()[0].name
    
    Out[2]:
    'Pipeline Assistant'
    Copyright © 2023 - Kodexa Inc
    Made with Material for MkDocs Insiders

    Cookie consent

    We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.