---

name: azure-ai-projects-ts description: "用于 Azure AI Foundry 项目的高级 SDK，支持 agents、连接、部署和评估。" risk: unknown source: community date_added: "2026-02-27"

Azure AI Projects SDK for TypeScript

用于 Azure AI Foundry 项目的高级 SDK，支持 agents、连接、部署和评估。

安装

npm install @azure/ai-projects @azure/identity

用于追踪：

npm install @azure/monitor-opentelemetry @opentelemetry/api

环境变量

AZURE_AI_PROJECT_ENDPOINT=https://<resource>.services.ai.azure.com/api/projects/<project>
MODEL_DEPLOYMENT_NAME=gpt-4o

认证

import { AIProjectClient } from "@azure/ai-projects";
import { DefaultAzureCredential } from "@azure/identity";

const client = new AIProjectClient(
  process.env.AZURE_AI_PROJECT_ENDPOINT!,
  new DefaultAzureCredential()
);

操作组

| 组 | 用途 | |---|------| | client.agents | 创建和管理 AI agents | | client.connections | 列出已连接的 Azure 资源 | | client.deployments | 列出模型部署 | | client.datasets | 上传和管理数据集 | | client.indexes | 创建和管理搜索索引 | | client.evaluators | 管理评估指标 | | client.memoryStores | 管理 agent 记忆 |

获取 OpenAI Client

const openAIClient = await client.getOpenAIClient();

// 用于响应
const response = await openAIClient.responses.create({
  model: "gpt-4o",
  input: "What is the capital of France?"
});

// 用于对话
const conversation = await openAIClient.conversations.create({
  items: [{ type: "message", role: "user", content: "Hello!" }]
});

Agents

创建 Agent

const agent = await client.agents.createVersion("my-agent", {
  kind: "prompt",
  model: "gpt-4o",
  instructions: "You are a helpful assistant."
});

带工具的 Agent

// Code Interpreter
const agent = await client.agents.createVersion("code-agent", {
  kind: "prompt",
  model: "gpt-4o",
  instructions: "You can execute code.",
  tools: [{ type: "code_interpreter", container: { type: "auto" } }]
});

// File Search
const agent = await client.agents.createVersion("search-agent", {
  kind: "prompt",
  model: "gpt-4o",
  tools: [{ type: "file_search", vector_store_ids: [vectorStoreId] }]
});

// Web Search
const agent = await client.agents.createVersion("web-agent", {
  kind: "prompt",
  model: "gpt-4o",
  tools: [{
    type: "web_search_preview",
    user_location: { type: "approximate", country: "US", city: "Seattle" }
  }]
});

// Azure AI Search
const agent = await client.agents.createVersion("aisearch-agent", {
  kind: "prompt",
  model: "gpt-4o",
  tools: [{
    type: "azure_ai_search",
    azure_ai_search: {
      indexes: [{
        project_connection_id: connectionId,
        index_name: "my-index",
        query_type: "simple"
      }]
    }
  }]
});

// Function Tool
const agent = await client.agents.createVersion("func-agent", {
  kind: "prompt",
  model: "gpt-4o",
  tools: [{
    type: "function",
    function: {
      name: "get_weather",
      description: "Get weather for a location",
      strict: true,
      parameters: {
        type: "object",
        properties: { location: { type: "string" } },
        required: ["location"]
      }
    }
  }]
});

// MCP Tool
const agent = await client.agents.createVersion("mcp-agent", {
  kind: "prompt",
  model: "gpt-4o",
  tools: [{
    type: "mcp",
    server_label: "my-mcp",
    server_url: "https://mcp-server.example.com",
    require_approval: "always"
  }]
});

运行 Agent

const openAIClient = await client.getOpenAIClient();

// 创建对话
const conversation = await openAIClient.conversations.create({
  items: [{ type: "message", role: "user", content: "Hello!" }]
});

// 使用 agent 生成响应
const response = await openAIClient.responses.create(
  { conversation: conversation.id },
  { body: { agent: { name: agent.name, type: "agent_reference" } } }
);

// 清理
await openAIClient.conversations.delete(conversation.id);
await client.agents.deleteVersion(agent.name, agent.version);

连接

// 列出所有连接
for await (const conn of client.connections.list()) {
  console.log(conn.name, conn.type);
}

// 按名称获取连接
const conn = await client.connections.get("my-connection");

// 获取带凭据的连接
const connWithCreds = await client.connections.getWithCredentials("my-connection");

// 获取按类型的默认连接
const defaultAzureOpenAI = await client.connections.getDefault("AzureOpenAI", true);

部署

// 列出所有部署
for await (const deployment of client.deployments.list()) {
  if (deployment.type === "ModelDeployment") {
    console.log(deployment.name, deployment.modelName);
  }
}

// 按发布者筛选
for await (const d of client.deployments.list()) {
  // 筛选逻辑
}