Universal.Operative.Sdk.Discrete.Microsoft.Foundry
1.3.2
See the version list below for details.
dotnet add package Universal.Operative.Sdk.Discrete.Microsoft.Foundry --version 1.3.2
NuGet\Install-Package Universal.Operative.Sdk.Discrete.Microsoft.Foundry -Version 1.3.2
<PackageReference Include="Universal.Operative.Sdk.Discrete.Microsoft.Foundry" Version="1.3.2" />
<PackageVersion Include="Universal.Operative.Sdk.Discrete.Microsoft.Foundry" Version="1.3.2" />
<PackageReference Include="Universal.Operative.Sdk.Discrete.Microsoft.Foundry" />
paket add Universal.Operative.Sdk.Discrete.Microsoft.Foundry --version 1.3.2
#r "nuget: Universal.Operative.Sdk.Discrete.Microsoft.Foundry, 1.3.2"
#:package Universal.Operative.Sdk.Discrete.Microsoft.Foundry@1.3.2
#addin nuget:?package=Universal.Operative.Sdk.Discrete.Microsoft.Foundry&version=1.3.2
#tool nuget:?package=Universal.Operative.Sdk.Discrete.Microsoft.Foundry&version=1.3.2
Universal.Operative.Sdk.Discrete.Microsoft.Foundry
Documents and failures
OpenAIResponses maps DocumentBlock to native input_file content for base64
data, public URLs, and OpenAI file IDs, including document-only messages. Inline
data uses the source media type and Title as the filename (default
document.pdf). TextSource documents become input_text. Unsupported source
kinds and file IDs explicitly issued by other providers throw
NotSupportedException. File availability, supported formats, size limits, and
model document capabilities remain provider constraints.
HTTP failures propagate Universal.Microsoft.Foundry.Client.FoundryException
unchanged: use StatusCode (for example, HTTP 429), ResponseBody, and RequestId.
Provider-reported failures in HTTP-success bodies or streaming events throw
FoundryResponseException, exposing ErrorCode, ErrorType, and an independent
Payload copy. These fields are provider-supplied and may be absent. Unexpected
stream termination remains a protocol failure (InvalidOperationException).
Applications choose fallback and retry policy; they need not parse exception
messages to identify provider-reported rate-limit codes or HTTP status codes.
Quick start
dotnet add package Universal.Operative.Sdk.Discrete.Microsoft.Foundry
using Universal.Microsoft.Foundry.Client;
using Universal.Operative.Sdk.Discrete;
using Universal.Operative.Sdk.Discrete.Microsoft.Foundry;
string apiKey = Environment.GetEnvironmentVariable("FOUNDRY_API_KEY")
?? throw new InvalidOperationException("Set FOUNDRY_API_KEY.");
using var client = new FoundryClient("https://my-resource.services.ai.azure.com", apiKey);
IModel model = new FoundryModel(
client, FoundryModel.ApiShape.OpenAIResponses,
"my-deployment", maxOutputTokens: 1024);
Choose OpenAIChat, OpenAIResponses, AnthropicMessages, or MaiChat for the deployment's API. Set the model ID to its Foundry deployment name.
Prompt caching
Azure OpenAI's provider caching remains automatic by default. Eligible requests need a repeated prompt prefix of at least 1,024 tokens. FoundryModel does not cache responses. Cache usage is reported in Message.Usage.Extensions when the provider returns it:
foundry.cached_tokens: Azure OpenAI cached input tokens.foundry.cache_write_tokens: Azure OpenAI cache writes, when reported by the deployment.- For Claude, the same
anthropicextension as the direct Anthropic adapter holdscacheReadInputTokensandcacheCreationInputTokens. Claude'sUsage.InputTokensis the uncached portion; useusage.GetTotalInputTokens()to include cache reads and writes. UseFoundryUsageExtensions.ProjectCompactionTokensas a compaction transformer's projected-token calculator.
The following Azure OpenAI controls are optional. Leave them unset to keep the provider default. Select a cache key based on prompts that share a stable prefix; a per-session key can help multi-turn affinity but may reduce reuse across sessions. Hash sensitive identifiers before sending them. PromptCacheRetention applies to supported older models; PromptCacheOptions, PromptCacheSystemBreakpoint, and PromptCacheBreakpointSelector are for deployments supporting explicit breakpoints (GPT-5.6 and later Standard deployments). The selector can mark a stable text or image block in a message. Set PromptCacheOptions to { "mode": "explicit" } to avoid the implicit latest-message cache write on GPT-5.6 and later; then mark at least one reusable prefix of 1,024 tokens or more. Unsupported controls may cause the provider to reject a request.
var model = new FoundryModel(client, FoundryModel.ApiShape.OpenAIResponses,
new FoundryModel.Options
{
ModelId = "my-deployment",
PromptCacheKeySelector = conversation => GetStableHashedCacheKey(conversation),
// PromptCacheSystemBreakpoint = true,
// PromptCacheOptions = JsonSerializer.SerializeToElement(new { mode = "explicit" }),
});
Claude's Foundry Messages shape follows the direct Anthropic adapter: it marks the tools, system prompt and latest message with five-minute ephemeral cache breakpoints by default. Set UsePromptCaching = false to omit these markers, or AnthropicPromptCacheTtl = "1h" if the longer, more expensive cache is appropriate.
License
Free for noncommercial use under the Universal.Operative Noncommercial License. Source is closed; commercial use requires a separate license from Andrew Ong.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- Universal.Microsoft.Foundry.Client (>= 1.1.0)
- Universal.Operative.Sdk.Discrete (>= 3.4.1)
-
net8.0
- Universal.Microsoft.Foundry.Client (>= 1.1.0)
- Universal.Operative.Sdk.Discrete (>= 3.4.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Fixes OpenAIResponses document input mapping, including document-only PDF messages. Exposes structured provider-reported failures through FoundryResponseException while preserving typed HTTP failures. Requires Universal.Operative.Sdk.Discrete 3.4.1 for interrupted tool-history recovery and compaction preservation fixes.