SDK_Core.md

graph LR
    SDK_Core["SDK Core"]
    Service_Modules["Service Modules"]
    Data_Models["Data Models"]
    Error_Handling["Error Handling"]
    SDK_Configuration["SDK Configuration"]
    Utility_Functions["Utility Functions"]
    Asynchronous_Synchronous_Adapters["Asynchronous/Synchronous Adapters"]
    Extensibility_Hooks_["Extensibility (Hooks)"]
    SDK_Core -- "provides base classes to" --> Service_Modules
    Service_Modules -- "utilizes" --> SDK_Core
    SDK_Core -- "serializes/deserializes" --> Data_Models
    Data_Models -- "defines format for" --> SDK_Core
    SDK_Core -- "raises exceptions from" --> Error_Handling
    Error_Handling -- "defines exceptions for" --> SDK_Core
    SDK_Core -- "consumes settings from" --> SDK_Configuration
    SDK_Configuration -- "provides parameters to" --> SDK_Core
    SDK_Core -- "defines interface for" --> Asynchronous_Synchronous_Adapters
    Asynchronous_Synchronous_Adapters -- "provides execution paths for" --> SDK_Core
    SDK_Core -- "invokes" --> Extensibility_Hooks_
    Extensibility_Hooks_ -- "modifies behavior of" --> SDK_Core
    Service_Modules -- "constructs requests with" --> Data_Models
    Service_Modules -- "returns responses as" --> Data_Models
    Service_Modules -- "handles exceptions from" --> Error_Handling
    Error_Handling -- "defines error types for" --> Service_Modules
    Utility_Functions -- "provides helpers to" --> SDK_Core
    Utility_Functions -- "provides helpers to" --> Service_Modules
    click SDK_Core href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/SDK_Core.md" "Details"
    click Service_Modules href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Service_Modules.md" "Details"
    click Error_Handling href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Error_Handling.md" "Details"

Loading

Details

This section synthesizes the architectural components of the Friendli AI Python SDK, focusing on the SDK Core and its interactions within a client-side SDK pattern.

SDK Core [Expand]

The foundational layer and central orchestrator of the SDK. It encapsulates the fundamental logic for API communication, request/response processing, and integrates core SDK abstractions. It provides the base classes (BaseSDK, AsyncSDK, SyncSDK) from which other service modules inherit, ensuring consistent interaction patterns and extensibility. It also manages global settings and extensibility points.

Related Classes/Methods:

• friendli_core.basesdk

Service Modules [Expand]

These modules encapsulate specific API functionalities (e.g., Chat, Completions, Image, Dataset). They extend the SDK Core's base classes to provide high-level, domain-specific methods for interacting with different parts of the Friendli AI platform.

Related Classes/Methods:

• friendli_core.chat
• friendli_core.completions

Data Models

Defines the structured data objects (e.g., request bodies, response objects) used for communication with the Friendli AI platform. These models ensure type safety, consistency, and ease of use when exchanging data with the API.

Related Classes/Methods:

• friendli_core.models

Error Handling [Expand]

Manages and standardizes error responses originating from the API or internal SDK operations. It provides custom exceptions and robust error handling mechanisms, allowing developers to gracefully manage and respond to issues.

Related Classes/Methods:

• friendli_core.errors

SDK Configuration

Manages global settings and parameters for the SDK, such as API keys, base URLs, timeouts, and other configurable options. It provides a centralized mechanism for developers to customize the SDK's behavior.

Related Classes/Methods:

• friendli_core.config

Utility Functions

Provides a collection of helper functions for common tasks that support the SDK's overall functionality. This includes operations like authentication, data serialization/deserialization, and other general-purpose utilities.

Related Classes/Methods:

• friendli_core.utils

Asynchronous/Synchronous Adapters

Provides distinct interfaces and implementations for both asynchronous (non-blocking) and synchronous (blocking) API calls. This allows developers to choose the appropriate execution model based on their application's architecture and performance requirements.

Related Classes/Methods:

• friendli_core.basesdk

Extensibility (Hooks)

Offers mechanisms for extending SDK behavior through hooks or context objects (e.g., HookContext). This allows developers to inject custom logic at various points in the request/response lifecycle without altering the core SDK code.

Related Classes/Methods:

• friendli_core.basesdk

FAQ