Foundry Local SDK リファレンス

C# SDK リファレンス

パッケージをインストールする

Windowsで開発または出荷する場合は、Windows タブを選択します。Windows パッケージは、Windows ML ランタイムと統合され、同じ API サーフェス領域に幅広いハードウェア アクセラレーションを提供します。

dotnet add package Microsoft.AI.Foundry.Local.WinML
dotnet add package OpenAI

dotnet add package Microsoft.AI.Foundry.Local
dotnet add package OpenAI

GitHub リポジトリの C# サンプルは、事前構成済みのプロジェクトです。 最初からビルドする場合は、Foundry Local を使用して C# プロジェクトを設定する方法の詳細については、 Foundry Local SDK リファレンスを参照 してください。

プロジェクト構成

サンプル リポジトリには、プラットフォーム検出を自動的に処理する .csproj ファイルが含まれています。 プロジェクトを最初からビルドする場合は、この構成を参照として使用します。

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
  </PropertyGroup>

  <!-- Windows: target Windows SDK for WinML hardware acceleration -->
  <PropertyGroup Condition="$([MSBuild]::IsOSPlatform('Windows'))">
    <TargetFramework>net9.0-windows10.0.26100</TargetFramework>
    <WindowsAppSDKSelfContained>false</WindowsAppSDKSelfContained>
    <Platforms>ARM64;x64</Platforms>
    <WindowsPackageType>None</WindowsPackageType>
    <EnableCoreMrtTooling>false</EnableCoreMrtTooling>
  </PropertyGroup>

  <!-- Non-Windows: standard .NET -->
  <PropertyGroup Condition="!$([MSBuild]::IsOSPlatform('Windows'))">
    <TargetFramework>net9.0</TargetFramework>
  </PropertyGroup>

  <PropertyGroup Condition="'$(RuntimeIdentifier)'==''">
    <RuntimeIdentifier>$(NETCoreSdkRuntimeIdentifier)</RuntimeIdentifier>
  </PropertyGroup>

  <!-- Windows: WinML for hardware acceleration -->
  <ItemGroup Condition="$([MSBuild]::IsOSPlatform('Windows'))">
    <PackageReference Include="Microsoft.AI.Foundry.Local.WinML" />
  </ItemGroup>

  <!-- Non-Windows: standard SDK -->
  <ItemGroup Condition="!$([MSBuild]::IsOSPlatform('Windows'))">
    <PackageReference Include="Microsoft.AI.Foundry.Local" />
  </ItemGroup>

  <!-- Linux GPU support -->
  <ItemGroup Condition="'$(RuntimeIdentifier)' == 'linux-x64'">
    <PackageReference Include="Microsoft.ML.OnnxRuntime.Gpu" />
    <PackageReference Include="Microsoft.ML.OnnxRuntimeGenAI.Cuda" />
  </ItemGroup>

  <!-- Shared utilities -->
  <ItemGroup>
    <Compile Include="../Shared/*.cs" />
  </ItemGroup>

</Project>

次の表では、プロジェクトの主要な設定について説明します。

クイック スタート

このスニペットを使用して、SDK がローカル モデル カタログを初期化してアクセスできることを確認します。

using Microsoft.AI.Foundry.Local;
using Microsoft.Extensions.Logging;
using System.Linq;

var config = new Configuration
{
  AppName = "app-name",
  LogLevel = Microsoft.AI.Foundry.Local.LogLevel.Information,
};

using var loggerFactory = LoggerFactory.Create(builder =>
{
  builder.SetMinimumLevel(Microsoft.Extensions.Logging.LogLevel.Information);
});
var logger = loggerFactory.CreateLogger<Program>();

await FoundryLocalManager.CreateAsync(config, logger);
var manager = FoundryLocalManager.Instance;

var catalog = await manager.GetCatalogAsync();
var models = await catalog.ListModelsAsync();

Console.WriteLine($"Models available: {models.Count()}");

次の使用例は、ハードウェアで使用できるモデルの数を出力します。

サンプル

• Foundry Local C# SDK の使用方法を示すサンプル アプリケーションについては、Foundry Local C# SDK Samples GitHub リポジトリを参照してください。

API リファレンス

• Foundry Local C# SDK の詳細については、 Foundry Local C# SDK API リファレンスを参照してください。

ネイティブ オーディオ文字起こし API

C# SDK には、デバイス上でささやきモデルを使用してオーディオ ファイルを文字起こしするためのネイティブ オーディオ クライアントが含まれています。 これにより、REST Web サーバーを必要とせずに、インプロセスで推論が実行されます。

オーディオ クライアントを取得する

ささやきモデルを読み込んだ後、オーディオ クライアントを取得します。

var audioClient = await model.GetAudioClientAsync();

オーディオ文字起こしメソッド

AudioClient の設定

例

var audioClient = await model.GetAudioClientAsync();
audioClient.Settings.Language = "en";
audioClient.Settings.Temperature = 0.0f;

await foreach (var chunk in audioClient.TranscribeAudioStreamingAsync(
    "recording.mp3", CancellationToken.None))
{
    Console.Write(chunk.Text);
}

参考資料:

• Foundry Local を使用してオーディオ ファイルを文字起こしする

JavaScript SDK リファレンス

パッケージをインストールする

Windowsで開発または出荷する場合は、Windows タブを選択します。Windows パッケージは、Windows ML ランタイムと統合され、同じ API サーフェス領域に幅広いハードウェア アクセラレーションを提供します。

npm install foundry-local-sdk-winml openai

npm install foundry-local-sdk openai

クイック スタート

このスニペットを使用して、SDK がローカル モデル カタログを初期化してアクセスできることを確認します。

import { FoundryLocalManager } from 'foundry-local-sdk';

console.log('Initializing Foundry Local SDK...');

const manager = FoundryLocalManager.create({
    appName: 'foundry_local_samples',
    logLevel: 'info'
});
console.log('✓ SDK initialized successfully');

// Explore available models
console.log('\nFetching available models...');
const catalog = manager.catalog;
const models = await catalog.getModels();

console.log(`Found ${models.length} models:`);
for (const model of models) {
    console.log(`  - ${model.alias}`);
}

この例では、ハードウェアで使用可能なモデルの一覧を出力します。

サンプル

• Foundry Local JavaScript SDK の使用方法を示すサンプル アプリケーションについては、Foundry Local JavaScript SDK Samples GitHub リポジトリを参照してください。

API リファレンス

• Foundry Local JavaScript SDK の詳細については、 Foundry Local JavaScript SDK API リファレンスを参照してください。

References

• 推論 SDK との統合
• Foundry Local Native Chat Completions API を使用する

Python SDK リファレンス

パッケージをインストールする

Windowsで開発または出荷する場合は、Windows タブを選択します。Windows パッケージは、Windows ML ランタイムと統合され、同じ API サーフェス領域に幅広いハードウェア アクセラレーションを提供します。

pip install foundry-local-sdk-winml openai

pip install foundry-local-sdk openai

クイック スタート

このスニペットを使用して、SDK がローカル モデル カタログを初期化してアクセスできることを確認します。

import asyncio
from foundry_local_sdk import Configuration, FoundryLocalManager


async def main():
    config = Configuration(app_name="app-name")
    FoundryLocalManager.initialize(config)
    manager = FoundryLocalManager.instance

    models = manager.catalog.list_models()
    print(f"Models available: {len(models)}")


if __name__ == "__main__":
    asyncio.run(main())

次の使用例は、ハードウェアで使用できるモデルの数を出力します。

サンプル

• Foundry Local Python SDK の使用方法を示すサンプル アプリケーションについては、Foundry Local SDK Samples GitHub リポジトリを参照してください。

コンフィギュレーション

Configuration クラスを使用すると、SDK の動作をカスタマイズできます。

from foundry_local_sdk import Configuration

config = Configuration(
    app_name="app-name",
    log_level="info",
    model_cache_dir="./foundry_local_data/model_cache",
    web={"urls": "http://127.0.0.1:55588"},
)

コア API

ネイティブ チャット完了 API

モデルを読み込んだ後、チャット クライアントを取得します。

client = model.get_chat_client()

ネイティブ オーディオ文字起こし API

ささやきモデルを読み込んだ後、オーディオ クライアントを取得します。

audio_client = model.get_audio_client()

参考資料:

• Foundry Local を使用してオーディオ ファイルを文字起こしする
• Foundry Local Native Chat Completions API を使用する
• REST サーバー経由でチャットの完了を使用する

Rust SDK リファレンス

パッケージをインストールする

Windowsで開発または出荷する場合は、Windows タブを選択します。Windows パッケージは、Windows ML ランタイムと統合され、同じ API サーフェス領域に幅広いハードウェア アクセラレーションを提供します。

cargo add foundry-local-sdk --features winml
cargo add tokio --features full
cargo add tokio-stream anyhow

cargo add foundry-local-sdk
cargo add tokio --features full
cargo add tokio-stream anyhow

クイック スタート

このスニペットを使用して、SDK がローカル モデル カタログを初期化してアクセスできることを確認します。

use foundry_local_sdk::{FoundryLocalConfig, FoundryLocalManager};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let manager = FoundryLocalManager::create(FoundryLocalConfig::new("app-name"))?;

    let models = manager.catalog().get_models().await?;
    println!("Models available: {}", models.len());

    Ok(())
}

次の使用例は、ハードウェアで使用できるモデルの数を出力します。

サンプル

• Foundry Local Rust SDK の使用方法を示すサンプル アプリケーションについては、Foundry Local SDK Samples GitHub リポジトリを参照してください。

コンフィギュレーション

FoundryLocalConfig構造体を使用すると、SDK の動作をカスタマイズできます。

use foundry_local_sdk::FoundryLocalConfig;

let config = FoundryLocalConfig::new("app-name")
    .with_log_level("info")
    .with_model_cache_dir("./foundry_local_data/model_cache")
    .with_web_urls("http://127.0.0.1:55588");

コア API

ネイティブ チャット補完 API

モデルを読み込んだ後、オプションの設定でチャット クライアントを作成します。

let client = model.create_chat_client()
    .temperature(0.7)
    .max_tokens(256);

メッセージの種類: ChatCompletionRequestSystemMessage、 ChatCompletionRequestUserMessage、 ChatCompletionRequestMessage。

ネイティブ オーディオ文字起こし API

ささやきモデルを読み込んだ後、オーディオ クライアントを作成します。

let audio_client = model.create_audio_client();

参考資料:

• Foundry Local を使用してオーディオ ファイルを文字起こしする
• Foundry Local Native Chat Completions API を使用する
• REST サーバー経由でチャットの完了を使用する