Skip to content

index.md

Latest commit

 

History

History
145 lines (113 loc) · 4.79 KB

index.md

File metadata and controls

145 lines (113 loc) · 4.79 KB

Python Provider Wrapper

日本語

aikernel-providers is the 0.1.2 Python distribution for official AIKernel extension providers.

The wrapper sits over C# provider packages; it is not a Python reimplementation of provider logic. It exposes a unified Python import surface:

from aikernel_providers import (
    ChatOpenAICapability,
    ChatOpenAIProvider,
    ChatOpenAISettings,
    ChatHistoryCapability,
    ChatHistoryProvider,
    ChatHistorySettings,
    CudaComputeCapability,
    CudaComputeProvider,
    CudaComputeSettings,
    DynamicPipelineCompilerCapability,
    DynamicPipelineCompilerProvider,
    DynamicPipelineCompilerSettings,
    LocalLlmCapability,
    LocalLlmProvider,
    LocalLlmSettings,
    MicrosoftAIProvider,
    MicrosoftAIProviderCapabilities,
    MicrosoftAIProviderOptions,
    provider_assemblies,
)

Install

After the stable 0.1.2 publication task opens:

pip install aikernel-providers==0.1.2

During local validation, install the matching 0.1.2.dev<build-number> wheel from the local package output.

Scope

The package exposes public provider wrappers and helper objects:

  • CapabilityContract
  • ChatOpenAICapability, ChatOpenAIProvider, ChatOpenAIInvoker, ChatOpenAISettings, ChatOpenAIClient
  • ChatHistoryCapability, ChatHistoryProvider, ChatHistoryInvoker, ChatHistorySettings, ChatHistoryRecord, ChatMessage, ChatHistory
  • CudaComputeCapability, CudaComputeProvider, CudaComputeInvoker, CudaComputeSettings
  • DynamicPipelineCompilerCapability, DynamicPipelineCompilerProvider, DynamicPipelineCompilerInvoker, DynamicPipelineCompilerSettings
  • LocalLlmCapability, LocalLlmProvider, LocalLlmInvoker, LocalLlmSettings
  • MicrosoftAIProvider, MicrosoftAIProviderOptions, MicrosoftAIProviderCapabilities, MicrosoftAICredential, MicrosoftAIHealthContext, MicrosoftAIResponseMapper, MicrosoftAIResponseProjection, MicrosoftAIProviderOptionsValidator
  • provider_assemblies()
  • load_provider_runtime()

It does not expose internal provider helpers, private runtime state, or provider-specific implementation details that are not part of the public C# package surface.

Managed Assemblies

The wheel bundles provider assemblies and manifest files under aikernel_providers/native:

  • ChatOpenAIProvider.dll
  • ChatHistoryProvider.dll
  • CudaComputeProvider.dll
  • DynamicPipelineCompilerProvider.dll
  • LocalLlmProvider.dll
  • AIKernel.Providers.MicrosoftAI.dll
  • provider manifest JSON files

provider_assemblies() is intended to resolve bundled assemblies first, then paths from AIKERNEL_PROVIDERS_ASSEMBLY_PATH, then matching NuGet packages from the global packages cache.

load_provider_runtime() is intended to load the resolved assemblies through pythonnet.

MicrosoftAI Provider

MicrosoftAI support is represented in the reference Python wrapper through MicrosoftAIProviderOptions, MicrosoftAIProviderCapabilities, response mapping wrappers, and the bundled AIKernel.Providers.MicrosoftAI.dll.

This provider was moved from AIKernel.Core into AIKernel.Providers management for the 0.1.2 release. The 0.1.2 Python wrapper follows that ownership change and stays thin over the managed provider surface.

Hosting and dependency-injection extension methods remain C# APIs.

Build

cd AIKernel.Providers
dotnet build AIKernel.Providers.slnx -c Release
dotnet test AIKernel.Providers.slnx -c Release --no-build
dotnet pack AIKernel.Providers.slnx -c Release --no-build --no-restore -p:UseLocalPackageVersion=true -p:LocalPackageBuildNumber=1 -o ..\artifacts\local-packages

Build Python wheels only as 0.1.2.dev<build-number> during local validation. Create stable 0.1.2 wheels only after the publication task opens.

API Example

from aikernel_providers import ChatOpenAICapability, provider_assemblies

contract = ChatOpenAICapability("openai.chat").to_contract()
print(contract.capability_id)
print(contract.provided_operations)

assemblies = provider_assemblies()
print(assemblies.is_complete())

The future Python wrapper must delegate to C# contract mappers and managed provider objects. Host applications should use the resulting contract objects to register providers with their AIKernel capability registry.

Trusted Publisher Configuration

The PyPI Trusted Publisher for the aikernel-providers project must match the GitHub OIDC claims emitted by this repository:

Field Value
PyPI project aikernel-providers
Owner AIKernel-NET
Repository AIKernel.Providers
Workflow publish-pypi.yml
Environment pypi

If PyPI reports invalid-publisher, do not change the workflow to token credentials. Fix the PyPI project Trusted Publisher entry so it matches the table above, then rerun the failed publish job.