How rapidataai/rapidata-python-sdk works
Main Components
a. Client Layer:
• Key client components: OrderManager, ValidationSetManager, and RapidsManager
b. Core Domain Objects:
• Orders (RapidataOrder, OrderBuilder)
• Workflows (ClassifyWorkflow, CompareWorkflow, etc.)
• Assets (MediaAsset, TextAsset, MultiAsset)
• Selections (ValidationSelection, DemographicSelection, etc.)
• Metadata handling components
c. Service Layer:
• CredentialManager
• TokenManager
• OpenAPIService
• LocalFileService
d. API Client Layer:
• Generated API clients (from OpenAPI specs)
• API models and endpoints
• REST communication handling
Relationships and Interactions
• Client → Service Layer (dependency)
• Client → Core Domain Objects (composition)
• Service Layer → API Client Layer (uses)
• Core Domain Objects → API Models (transforms)
Component Details
For each major component, include:
• Component name
• Key responsibilities
• Major public interfaces
• Dependencies
Specific Implementation Details
Specialized sections for:
• Authentication flow
• Order creation pipeline
• Validation handling
• Asset management
┌─────────────────────────────────────────────────────┐
• Client Interface │
• (RapidataClient, OrderManager, ValidationManager) │
• ┤
• Domain Objects │
• (Orders, Workflows, Assets, Selections, Metadata) │
• ┤
• Service Layer │
• (Credential, Token, OpenAPI, File Services) │
• ┤
• API Client Layer │
• (Generated Clients, Models, REST Communication) │
• ┤
• External API │
• (Rapidata API Service) │
• ┘
Technical Details to Highlight
• OpenAPI generation workflow
• Authentication mechanisms
• File handling capabilities
• Validation patterns
• Order lifecycle management