Azure AI Projects Python SDK（Foundry SDK）

使用 azure-ai-projects SDK 在 Azure AI Foundry 上构建 AI 应用程序。

安装

pip install azure-ai-projects azure-identity

环境变量

AZURE_AI_PROJECT_ENDPOINT="https://.services.ai.azure.com/api/projects/"
AZURE_AI_MODEL_DEPLOYMENT_NAME="gpt-4o-mini"

身份验证

import os
from azure.identity import DefaultAzureCredential
from azure.ai.projects import AIProjectClient

credential = DefaultAzureCredential()
client = AIProjectClient(
    endpoint=os.environ["AZURE_AI_PROJECT_ENDPOINT"],
    credential=credential,
)

客户端操作概览

两种客户端使用方式

1. AIProjectClient（原生 Foundry 方式）

from azure.ai.projects import AIProjectClient

client = AIProjectClient(
    endpoint=os.environ["AZURE_AI_PROJECT_ENDPOINT"],
    credential=DefaultAzureCredential(),
)

# 使用 Foundry 原生操作
agent = client.agents.create_agent(
    model=os.environ["AZURE_AI_MODEL_DEPLOYMENT_NAME"],
    name="my-agent",
    instructions="You are helpful.",
)

2. 兼容 OpenAI 的客户端

# 从项目获取兼容 OpenAI 的客户端
openai_client = client.get_openai_client()

# 使用标准 OpenAI API
response = openai_client.chat.completions.create(
    model=os.environ["AZURE_AI_MODEL_DEPLOYMENT_NAME"],
    messages=[{"role": "user", "content": "Hello!"}],
)

Agent 操作

创建 Agent（基础版）

agent = client.agents.create_agent(
    model=os.environ["AZURE_AI_MODEL_DEPLOYMENT_NAME"],
    name="my-agent",
    instructions="You are a helpful assistant.",
)

创建带工具的 Agent

from azure.ai.agents import CodeInterpreterTool, FileSearchTool

agent = client.agents.create_agent(
    model=os.environ["AZURE_AI_MODEL_DEPLOYMENT_NAME"],
    name="tool-agent",
    instructions="You can execute code and search files.",
    tools=[CodeInterpreterTool(), FileSearchTool()],
)

使用 PromptAgentDefinition 创建带版本的 Agent

from azure.ai.projects.models import PromptAgentDefinition

# 创建带版本的 Agent
agent_version = client.agents.create_version(
    agent_name="customer-support-agent",
    definition=PromptAgentDefinition(
        model=os.environ["AZURE_AI_MODEL_DEPLOYMENT_NAME"],
        instructions="You are a customer support specialist.",
        tools=[],  # 根据需要添加工具
    ),
    version_label="v1.0",
)

详见 references/agents.md 中关于 Agent 的详细模式说明。

工具概览

所有工具的使用模式详见 references/tools.md。

会话线程（Thread）与消息流

# 1. 创建 thread
thread = client.agents.threads.create()

# 2. 添加消息
client.agents.messages.create(
    thread_id=thread.id,
    role="user",
    content="What's the weather like?",
)

# 3. 创建并处理 run
run = client.agents.runs.create_and_process(
    thread_id=thread.id,
    agent_id=agent.id,
)

# 4. 获取响应
if run.status == "completed":
    messages = client.agents.messages.list(thread_id=thread.id)
    for msg in messages:
        if msg.role == "assistant":
            print(msg.content[0].text.value)

连接（Connections）

# 列出所有 connection
connections = client.connections.list()
for conn in connections:
    print(f"{conn.name}: {conn.connection_type}")

# 获取指定 connection
connection = client.connections.get(connection_name="my-search-connection")

连接相关使用模式详见 references/connections.md。

部署（Deployments）

# 列出可用的模型部署
deployments = client.deployments.list()
for deployment in deployments:
    print(f"{deployment.name}: {deployment.model}")

部署相关使用模式详见 references/deployments.md。

数据集（Datasets）与索引（Indexes）

# 列出数据集
datasets = client.datasets.list()

# 列出索引
indexes = client.indexes.list()

数据操作相关说明详见 references/datasets-indexes.md。

评估（Evaluation）

# 使用 OpenAI 客户端执行评估
openai_client = client.get_openai_client()

# 使用内置评估器创建评估任务
eval_run = openai_client.evals.runs.create(
    eval_id="my-eval",
    name="quality-check",
    data_source={
        "type": "custom",
        "item_references": [{"item_id": "test-1"}],
    },
    testing_criteria=[
        {"type": "fluency"},
        {"type": "task_adherence"},
    ],
)

评估相关使用模式详见 references/evaluation.md。

异步客户端（Async Client）

from azure.ai.projects.aio import AIProjectClient

async with AIProjectClient(
    endpoint=os.environ["AZURE_AI_PROJECT_ENDPOINT"],
    credential=DefaultAzureCredential(),
) as client:
    agent = await client.agents.create_agent(...)
    # ... 异步操作

异步使用模式详见 references/async-patterns.md。

内存存储（Memory Stores）

# 为 Agent 创建内存存储
memory_store = client.agents.create_memory_store(
    name="conversation-memory",
)

# 将其附加至 Agent，实现持久化记忆能力
agent = client.agents.create_agent(
    model=os.environ["AZURE_AI_MODEL_DEPLOYMENT_NAME"],
    name="memory-agent",
    tools=[MemorySearchTool()],
    tool_resources={"memory": {"store_ids": [memory_store.id]}},
)

最佳实践

1. 使用上下文管理器 管理异步客户端：async with AIProjectClient(...) as client:
2. 及时清理 Agent：任务完成后调用 client.agents.delete_agent(agent.id)
3. 对简单运行使用 create_and_process，对实时用户体验（UX）则优先采用 流式响应（streaming）
4. 生产环境部署应使用带版本的 Agent
5. 推荐使用 connection 集成外部服务（如 AI Search、Bing 等）

SDK 对比

参考文档文件

• references/agents.md：使用 PromptAgentDefinition 的 Agent 操作示例
• references/tools.md：全部 Agent 工具及其使用示例
• references/evaluation.md：评估操作及内置评估器说明
• references/connections.md：连接（connection）操作说明
• references/deployments.md：模型部署枚举说明
• references/datasets-indexes.md：数据集与索引操作说明
• references/async-patterns.md：异步客户端使用说明