Foundry 託管代理程式

Microsoft Foundry Agent Service 中的託管代理程式允許您將容器化代理應用程式部署到 Microsoft 管理的基礎設施中。 該平台處理擴展性、會話狀態持久性、安全性與生命週期管理,讓您能專注於代理程式的邏輯。 Microsoft Foundry 託管代理程式已普遍提供,支援使用自編程式碼或偏好代理框架所建置的代理程式。 本文特別介紹 Agent Framework 主機整合。

透過 Agent Framework 的託管整合,你只需少量程式碼,即可透過 Foundry Responses 或 Invocations 通訊協定公開 Agent,其中包括以 Workflow.as_agent() 包裝的工作流程。

備註

你也可以透過 Azure Developer CLI (azd) 工作流程,將用其他框架編寫的代理程式部署到 Foundry 託管代理上。 關於框架無關的概念與部署指引,請參閱「 什麼是託管代理?」 本文其餘部分將聚焦於 Agent Framework 的整合。

何時使用託管代理

選擇 Foundry 託管代理,當您希望達成以下目的時:

  • 託管基礎設施 ——無需自行配置容器、網頁伺服器或擴展規則。
  • 內建會話管理 — 平台能 $HOME 在回合與閒置期間持續存檔並上傳檔案。
  • 專用代理身份 — 每個部署的代理都會擁有自己的 Entra 身份,以確保對模型、工具及下游服務的安全存取。
  • OpenAI 相容端點 — 客戶端可透過 Responses 協議,使用任何 OpenAI 相容 SDK 與您的客服人員互動。
  • 對於即時音訊代理程式,請在 Foundry Tools (Voice Live) 中使用搭配 Azure Speech 的託管代理程式,以進行伺服器端的語音活動偵測、回聲消除及降噪。 如需詳細資訊,請參閱 搭配託管代理程式使用 Voice Live。

備註

Python agent-framework-foundry-hosting 整合目前是預發布狀態。 Microsoft Foundry 託管代理服務,作為託管主機服務,已普遍提供。

Prerequisites

本地測試,你還需要:

安裝主機 NuGet 套件:

dotnet add package Microsoft.Agents.AI.Foundry.Hosting --prerelease
  • Python 3.10 或更新版本

安裝預發布的主機套件、Foundry 客戶端和 Azure 認證套件:

pip install --pre agent-framework-foundry agent-framework-foundry-hosting azure-identity

在 Foundry 中,平台提供呼叫者的使用者上下文與通話上下文;主機基礎設施利用這些工具來隔離每位使用者的狀態,並將請求上下文轉發給 Foundry 服務。 在本機執行時不會收到該平台的情境資訊,因此應用程式必須在需要時自行提供身分識別與狀態控管機制。

回應協定

回應協議是大多數代理人的推薦起點。 它提供一個相容 /responses OpenAI 的端點,平台自動管理對話歷史、串流和會話生命週期。

對於 Python 託管代理來說,提前結束的回應會帶有incomplete狀態。 串流用戶端會接收終端 response.incomplete 事件,而非串流用戶端則會收到 status 設定為 incomplete的事件。 content_filter 結束原因會對應到設為 max_output_tokens 的 length,而 incomplete_details.reason 會對應到 content_filter。 任何產生的輸出或拒絕內容仍保留在回應中。

using Azure.AI.AgentServer.Core;
using Azure.AI.Projects;
using Azure.Identity;
using Microsoft.Agents.AI;
using Microsoft.Agents.AI.Foundry.Hosting;

var projectEndpoint = new Uri(Environment.GetEnvironmentVariable("FOUNDRY_PROJECT_ENDPOINT")
    ?? throw new InvalidOperationException("FOUNDRY_PROJECT_ENDPOINT is not set."));
var deployment = Environment.GetEnvironmentVariable("AZURE_AI_MODEL_DEPLOYMENT_NAME") ?? "gpt-4o";

AIAgent agent = new AIProjectClient(projectEndpoint, new DefaultAzureCredential())
    .AsAIAgent(
        model: deployment,
        instructions: "You are a helpful AI assistant.",
        name: "my-agent");

var builder = AgentHost.CreateBuilder(args);
builder.Services.AddFoundryResponses(agent);
builder.RegisterProtocol("responses", endpoints => endpoints.MapFoundryResponses());

var app = builder.Build();
app.Run();

AgentHost.CreateBuilder會為 Foundry 主機環境預先設定一個應用程式主機。 AddFoundryResponses 會將您的代理程式註冊至 Responses 通訊協定處理常式,而 MapFoundryResponses 則對應 /responses HTTP 端點。

import os

from agent_framework import Agent
from agent_framework.foundry import FoundryChatClient
from agent_framework_foundry_hosting import ResponsesHostServer
from azure.identity import DefaultAzureCredential

client = FoundryChatClient(
    project_endpoint=os.environ["FOUNDRY_PROJECT_ENDPOINT"],
    model=os.environ["AZURE_AI_MODEL_DEPLOYMENT_NAME"],
    credential=DefaultAzureCredential(),
)

agent = Agent(
    client=client,
    instructions="You are a helpful AI assistant.",
)

server = ResponsesHostServer(agent)
server.run()

ResponsesHostServer 包裹你的代理,並透過 Foundry Responses 協定將其公開。 呼叫者的 store 欄位控制外部回應及主機管理的會話與核准狀態是否被保存。 history_source 設定可獨立選擇由誰提供模型歷程:

history_source 模型歷史行為
"agent_server" (預設值) 主機重建儲存的外部回應轉錄本,並停用下游服務儲存,以防止重複歷史。
"service" 主機只會傳送目前的輸入,並私密儲存模型儲存服務的接續 ID。 儲存的提供者對話無法從較早的回應另行分支。
"agent" 主機只傳送目前的輸入。 代理程式的 HistoryProvider 或下游服務的儲存預設值會管理歷程記錄。

請勿將 "agent_server" 或 "service" 與已啟用負載功能的 HistoryProvider 搭配使用。 預設模式也拒絕固定的下游延續選項,如 conversation_id、 previous_response_id和 conversation。 使用 history_source="agent" 來實作自訂的 SupportsAgentRun。

response_store建構參數選擇後端以維持外部回應的持久性。 較舊的建構函式參數 store 是 response_store 的已淘汰別名;這兩個參數都不會設定呼叫者每個請求的 store 欄位。 帶有 store=false 的請求屬於一次性請求:不會儲存由主機管理的狀態、會停用受支援的下游儲存體,且無法使用 background=true。

主機擁有所提供的代理,並可能新增主機專用的上下文提供者。 不要在其他主機重複使用代理,或是在主機建置後直接呼叫。

Responses 主機保留原生電腦通話、截圖及安全檢查。 您的應用程式必須執行所要求的動作,並明確確認任何安全檢查。 完整流程請參見 原生電腦使用。

選擇代理實例或工廠

InvocationsHostServer 和 ResponsesHostServer 都可透過 agent 參數接受代理程式執行個體,或是不接受任何引數的同步或非同步可呼叫物件。 主機會在其整個生命週期內重複使用同一個實例。 可呼叫物件每個請求只會執行一次,且回傳的代理屬於該請求。

當代理程式在 AgentSession 外部保留可變狀態時,請使用可呼叫物件。 特別是,從可建立全新工作流程、執行器和封裝代理程式的工廠建立一個 WorkflowAgent:

def create_workflow_agent():
    return build_workflow().as_agent(name="support-workflow")


server = ResponsesHostServer(agent=create_workflow_agent)

保持工作流程名稱和執行器 ID 穩定,讓後續回應請求能找到已儲存的檢查點。 ResponsesHostServer 透過其工作階段、檢查點和函式核准存放區維持受支援的狀態;它不會將任意欄位持續儲存在以要求為範圍的 Agent 上。 請參閱 工作流程 與 韌性長期執行工作流程 範例。

當整合會攜帶要求識別資訊,或持有要求專屬的資源時,也要使用工廠。 例如,在工廠內建立 MCP 連線、工具箱、技能提供者、搜尋客戶端、記憶體提供者,以及它們在使用當前平台呼叫或使用者上下文時的憑證。 重複使用整個程序共用的 MCP 連線,可能會保留開啟該連線之請求的身分。

針對每個請求,主機都會進入並離開由工廠建立的代理程式。 Agent 會管理受情境管理的用戶端和 MCP 工具,但你的工廠必須關閉或清理它所建立的任何其他提供者、傳輸機制或憑證。 不要關閉應用程式從工廠外提供的共用物件。

持續狀態並處理長時間對話

ResponsesHostServer 和 InvocationsHostServer 預設會設定持久性工作階段儲存體。 AgentSessionStoreProvider 提供 FoundryAgentSessionStore;Responses 工作階段使用 agent_sessions 邏輯存放區,而 Invocations 工作階段使用獨立的 invocation_sessions 存放區。 這些存放區在託管時會使用 Foundry State Store,而在本機執行時則會使用 SDK 的檔案型儲存體。

對於 Responses 工作流程代理程式,CheckpointStoreProvider 會提供一個 FoundryCheckpointStore。 FunctionApprovalStoreProvider 提供用於待核准項目的 FoundryFunctionApprovalStore。

在 Foundry 中執行時,預設的 Python 會以平台使用者 ID 和 Foundry 沙箱會話 ID 儲存命名空間狀態。 他們也要求每個州的營運都設定一個平台呼叫ID。 通話識別碼授權並關聯操作;它不是對話 ID,也不是儲存金鑰的一部分。

對於回應,平台配置 FOUNDRY_AGENT_SESSION_ID 會識別沙盒,並拒絕另一個呼叫者提供的 agent_session_id 呼叫。 對於叫用,主機會依據請求內容驗證經路由處理的查詢參數 agent_session_id。 如果 FOUNDRY_AGENT_SESSION_ID 未設定,查詢參數必須存在、非空且符合請求上下文。 缺少、重複或衝突的值會被拒絕,而不是使用 SDK 備援 ID。

這些保證適用於預設的託管商店。 自訂儲存提供者必須實現等效的使用者與沙盒隔離,將內部 AgentSession.session_id 資料與主機查詢鍵分開保存,並使用條件寫入,避免過時的請求覆蓋較新的快照。 新鍵應該只用創建寫入,而非無條件的上溢點。 請參閱 Cosmos DB 中具備 ETag 保護寫入與刪除功能的 自訂儲存範例 。

使用 history_source="agent" 時,已設定的工作階段儲存區會持久保存由 AgentSession 攜帶的提供者狀態,包括來自 InMemoryHistoryProvider 的訊息。

兩個主機都接受一個從 StoreProvider[SessionStore] 到 agent_session_store_provider 的範圍。 會話狀態必須支援序列 AgentSession 化。 使用 register_state_type() 為自訂狀態類型註冊編解碼器;還原的狀態不會保留 Python 物件識別。 新的預設儲存會在最後一次寫入後 30 天內結束會話。 自訂提供者自行控管其保留設定。

有範圍的預設儲存庫不會讀取舊有的無範圍agent_sessionsinvocation_sessions、檢查點或函數核准資料。 請開始新的 Responses 對話,而不要重複使用舊的 previous_response_id 或對話 ID。 呼叫從作用域儲存中的空代理框架會話開始。

已載入的AgentSession紀錄會套用 ETag 條件。 如果另一個請求先讓同一工作階段往前推進,過時的寫入就會失敗,而不會覆寫較新的狀態。 此檢查不提供代理或工具副作用的交易或精確一次執行,因此應用程式仍需協調重疊請求。

對於回應專用的儲存,請將 a StoreProvider 傳遞到 function_approval_store_provider 或 a ContextScopedStoreProvider 傳遞給 checkpoint_store_provider。

外部背景作業使用對呼叫端可見的 response.id 來進行輪詢。 預設 background_source="agent_server" 會保留主機的背景執行。 僅將 background_source="provider" 與 history_source="service" 及可儲存、可續傳的 Responses 用戶端搭配使用。 若 ResponsesServerOptions(resilient_background=True) 也設定為 ,主機只能在儲存私有延續標記後恢復提供者輪詢。 讓本地工具的副作用具備冪等性,因為如果在儲存下一個 token 之前發生當機,就可能再次執行這些副作用。

從 azure.ai.agentserver.responses 匯入 ResponsesServerOptions,並透過 ResponsesHostServer 參數將其傳遞給 options。 可用的長時間對話選項依代理類型而異:

能力 代理人類型 需求與行為
工作流程檢查點的背景復原 僅工作流程 設定 ResponsesServerOptions(resilient_background=True)。 請傳送含有 store=true 和 background=true 的 Responses 要求。 重新啟動後,主機會繼續執行最新的持久性工作流程檢查點;如果沒有檢查點,則會重新執行原始輸入。 不要在工作流程中設定檢查點儲存體,因為這是由主機管理的。 請確保外部副作用具備冪等性,因為最後一個持久性檢查點之後的工作可能會被重複執行。
供應商原生背景回應 非工作流程型 Agent,搭配可儲存 Responses 的用戶端 集合 history_source="service" 和 background_source="provider"。 如果儲存的提供者接續權杖必須在主機重新啟動後仍可保留,請設定 resilient_background=True
可引導的對話 暫時無法使用 請勿設定 steerable_conversations=True。 主機在建置期間會提高 RuntimeError,直到 Agent Server SDK 能安全處理遭拒的轉向操作。

完整實作請參閱 自訂儲存、 基本回應歷史與背景,以及 韌性長期執行的工作流程 範例。

從託管沙盒讀取檔案

將託管沙盒的持久化 $HOME 視為請求路由資源,而非一般的檔案系統邊界。 只接受應用程式明確上傳到專用目錄的檔案,驗證目前沙盒身份,並拒絕絕對路徑、遍歷、連結、非規則檔案以及過大或無效內容。

對於回應協定,將請求路由到帶有 agent_session_id 主體欄位的託管會話。 查詢字串選擇器供叫用使用。 會話上傳與 Toolbox 程式碼直譯器檔案是分開的資源;上傳的沙盒檔案不會自動掛載到 Toolbox 容器中。 請參閱 會話檔案範例 ,了解有界 UTF-8 讀取及本地與託管上傳指引。

控制請求選項

主機會將原生回應產生欄位對應到 Agent Framework 的執行選項。 例如 max_output_tokens 會成為 max_tokens,而 parallel_tool_calls 會成為 allow_multiple_tool_calls。 來自 extra_body 的扁平化值會覆寫已翻譯的原生值。

在一般代理執行前,使用同步或非同步 prepare_options(request, options) 掛鉤移除或替換呼叫者模型選項。 這個掛鉤無法設定由主機控制的身分、儲存、接續或傳輸欄位。 對於無法接受執行時模型選項的自訂 SupportsAgentRun 實作,請設 unsupported_options 為 "warn" (預設值)、 "ignore"或 "error"。

當 Foundry 託管的 MCP 工具需要使用者同意時,會 ResponsesHostServer 回傳一個不完整的回應並附帶 oauth_consent_request 輸出項目。 將其 consent_link 呈現給使用者,然後在使用者完成同意後繼續使用不完整回應的識別碼做為 previous_response_id 。 主機會保留代理會話以供此重試使用,並只公開絕對的 HTTPS 同意連結。

如果你的主機知道預期的授權來源,請限制同意連結:allowed_oauth_consent_origins

server = ResponsesHostServer(
    agent,
    allowed_oauth_consent_origins=[
        "https://logic-region.consent.azure-apihub.net",
        "https://auth.partner.example",
    ],
)

省略允許清單可保持絕對 HTTPS 驗證,且不限制目的地來源。 提供空清單會拒絕所有同意連結。 僅設定精確的 HTTPS 來源;包含路徑、查詢或片段的條目會被拒絕。

呼叫協定

Invocations 協定讓你能完全控制 HTTP 請求與回應。 當你需要自訂有效載荷、非對話式處理,或是不支援 OpenAI 的串流協定時,才會使用它。

使用 C# 中的 Invocations 協定,您可以實現一個自訂 InvocationHandler 来處理來的請求:

using Azure.AI.AgentServer.Core;
using Azure.AI.AgentServer.Invocations;
using Microsoft.Agents.AI;

var builder = AgentHost.CreateBuilder(args);

builder.Services.AddSingleton<AIAgent, MyAgent>();
builder.Services.AddInvocationsServer();
builder.Services.AddScoped<InvocationHandler, MyInvocationHandler>();

builder.RegisterProtocol("invocations", endpoints => endpoints.MapInvocationsServer());

var app = builder.Build();
app.Run();

此 AddInvocationsServer 方法會註冊呼叫協定服務。 你實作 InvocationHandler 來定義代理如何處理每個請求。

想要輕量化的配置,請使用 InvocationsHostServer 套件中的 agent_framework_foundry_hosting。 它會將您的代理類似於 ResponsesHostServer 一樣封裝,並自動處理會話管理:

import os

from agent_framework import Agent
from agent_framework.foundry import FoundryChatClient
from agent_framework_foundry_hosting import InvocationsHostServer
from azure.identity import DefaultAzureCredential

client = FoundryChatClient(
    project_endpoint=os.environ["FOUNDRY_PROJECT_ENDPOINT"],
    model=os.environ["AZURE_AI_MODEL_DEPLOYMENT_NAME"],
    credential=DefaultAzureCredential(),
)

agent = Agent(
    client=client,
    instructions="You are a friendly assistant. Keep your answers brief.",
    default_options={"store": False},
)

server = InvocationsHostServer(agent)
server.run()

InvocationsHostServer 接受與回應主機描述相同的實例或請求範圍的工廠表單。 它會從已設定的儲存庫還原序列化的會話,讓完成的對話在主機重啟後仍能繼續。 關於儲存行為、保留與自訂,請參見 持久狀態與處理長期對話。

當被託管時,Invocations 會使用持久狀態中描述的已驗證請求範圍 ,並處理長時間執行的對話。 將 AgentSession.session_id 視為一個不透明值;不要解析或依賴其內部表示。 本地執行則保留其現有的單用戶儲存行為。

自訂呼叫請求與回應

預設情況下, POST /invocations 接受包含字串 message、 可選 options 物件及可選布林 stream 值的 JSON 物件。 要接受特定應用的有效載荷,請傳遞一個同步或非同步 parse_request 回調,返回 InvocationRun(messages, options, stream)。 在代理執行前,請用 prepare_options 來篩選或替換來電產生選項的副本。

主機會驗證掛鉤輸出,並拒絕平台身份、儲存、延續及代理執行控制。 對於不接受執行時選項的代理,請設 unsupported_options 為 "warn" (預設值)、 "ignore"或 "error"。 完整實作請參見 Invocations 解析器範例 。

非串流成功時會以如下的 JSON 格式傳回:{"response": "..."} 串流使用伺服器傳送事件:先傳送一個或多個 event: delta 框格,接著在成功時傳送 event: done,或在失敗時傳送 event: error。 串流在發生錯誤前可能會先傳送 delta,因此用戶端必須將 done 而非 delta 視為成功完成。 主機只有在完成回應串流並持續執行AgentSession後才會發出done。 它的 session_id 是平台沙盒路由 ID,不是序列化的 AgentSession.session_id。

僅在遷移需要先前純文字回應與原始文字區塊串流的現有用戶端時設定 legacy_wire_format=True 。 此相容模式已被棄用,且無法將失敗轉換為成功的文字。 主機僅會在單一行程內將同一工作階段的請求序列化;但在外部工具造成影響之後,仍可能發生跨行程的比較並交換衝突。

叫用通訊協定不會繼續執行處於待處理或已中斷狀態的工作流程執行。 當你需要不同的工作流程延續行為時,請使用以下章節的自訂處理模式。

為了完全掌控要求處理,請直接從 azure.ai.agentserver.invocations 套件使用 InvocationAgentServerHost 並實作您自己的叫用處理常式:

import os
from collections.abc import AsyncGenerator

from agent_framework import Agent, AgentSession
from agent_framework.foundry import FoundryChatClient
from azure.ai.agentserver.invocations import InvocationAgentServerHost
from azure.identity import DefaultAzureCredential
from starlette.requests import Request
from starlette.responses import JSONResponse, Response, StreamingResponse

_sessions: dict[str, AgentSession] = {}

client = FoundryChatClient(
    project_endpoint=os.environ["FOUNDRY_PROJECT_ENDPOINT"],
    model=os.environ["AZURE_AI_MODEL_DEPLOYMENT_NAME"],
    credential=DefaultAzureCredential(),
)

agent = Agent(
    client=client,
    instructions="You are a friendly assistant. Keep your answers brief.",
    default_options={"store": False},
)

app = InvocationAgentServerHost()


@app.invoke_handler
async def handle_invoke(request: Request):
    """Handle streaming multi-turn chat."""
    data = await request.json()
    session_id = request.state.session_id
    stream = data.get("stream", False)
    user_message = data.get("message", None)

    if user_message is None:
        return Response(content="Missing 'message' in request", status_code=400)

    session = _sessions.setdefault(session_id, AgentSession(session_id=session_id))

    if stream:

        async def stream_response() -> AsyncGenerator[str]:
            async for update in agent.run(user_message, session=session, stream=True):
                yield update.text

        return StreamingResponse(
            stream_response(),
            media_type="text/event-stream",
            headers={"Cache-Control": "no-cache", "Connection": "keep-alive"},
        )

    response = await agent.run([user_message], session=session, stream=stream)
    return JSONResponse({"response": response.text})


if __name__ == "__main__":
    app.run()

Warning

自訂處理常式範例中的記憶體內部工作階段存放區會在重新啟動時遺失。 在生產環境中使用耐用儲存(例如 Cosmos DB)。

完整的 Invocations 部署,請參閱 Foundry 託管的 Telegram 範例。 它將 API 管理置於託管代理 webhook 前方,並使用受管理身份、金鑰保存庫 與 Cosmos DB 來保存持久的對話歷史。

備註

Go 對 Foundry 託管代理的支援即將推出。 最新狀態請參閱 Agent Framework Go 倉庫 。

Tip

請參閱 Python 範例或 C# 範例,了解託管代理專案的範例。 或者用這個 azd ai agent init 指令從零開始搭建新的託管代理專案。 請參閱這份 快速入門指南 ,了解逐步說明。

正在本機執行

Azure 開發者 CLI(azd)提供了最簡單的本地運行與測試主機代理的方式。

初始化專案

建立一個新資料夾,並從範例清單初始化:

mkdir my-hosted-agent && cd my-hosted-agent
azd ai agent init -m <path-to-agent.manifest.yaml>

Tip

清單可以是本地 YAML 檔案的路徑,或是遠端清單的 URL。

設定環境變數

export FOUNDRY_PROJECT_ENDPOINT="https://<account>.services.ai.azure.com/api/projects/<project>"
export AZURE_AI_MODEL_DEPLOYMENT_NAME="<your-model-deployment>"

執行代理程式託管

azd ai agent run

代理主機從 http://localhost:8088開始。

召喚代理人

azd ai agent invoke --local "Hello!"

或者使用 curl:

curl -X POST http://localhost:8088/responses \
  -H "Content-Type: application/json" \
  -d '{"input": "Hello!"}'

或者用 PowerShell 來做:

(Invoke-WebRequest -Uri http://localhost:8088/responses -Method POST -ContentType "application/json" -Body '{"input": "Hello!"}').Content

部署至 Foundry

一旦你在本地驗證了代理程式,就部署到 Microsoft Foundry:

  1. 資源配置 (如果你還沒有 Foundry 專案):

    azd provision
    

    這會建立一個資源群組,包含 Foundry 實例、專案、模型部署、應用洞察以及容器登錄檔。

  2. 部署代理:

    azd deploy
    

    這會將你的代理程式打包成容器映像,推送到 Azure Container Registry,然後部署到 Foundry Agent Service。

Foundry 的主機架構會在執行時自動將以下環境變數注入你的代理容器:

Variable 說明
FOUNDRY_PROJECT_ENDPOINT Foundry 專案的端點網址。
AZURE_AI_MODEL_DEPLOYMENT_NAME 模型部署名稱(在 azd ai agent init 設定時配置)。
APPLICATIONINSIGHTS_CONNECTION_STRING Application Insights 的遙測連線字串。

部署完成後,代理程式可透過其專用的 Foundry 端點存取,並可從 Foundry 入口網站進行測試。

下一步