Hr Common LLM

接口规范

基本信息

可用模型

请求体结构（OpenAI 标准）

{
  "model": "HY-3-Preview",
  "messages": [
    { "role": "system", "content": "你是一个有帮助的助手" },
    { "role": "user", "content": "用户的问题或指令" }
  ],
  "temperature": 0.7,
  "max_tokens": 2048,
  "stream": false
}

核心参数说明

messages 消息角色

响应结构

非流式响应

{
  "id": "chatcmpl-xxx",
  "object": "chat.completion",
  "created": 1677858242,
  "model": "HY-3-Preview",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "AI的回复内容"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 10,
    "completion_tokens": 20,
    "total_tokens": 30
  }
}

流式响应（SSE）

流式响应返回 text/event-stream 格式，每个数据块格式如下：

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","created":1677858242,"model":"HY-3-Preview","choices":[{"index":0,"delta":{"content":"内"},"finish_reason":null}]}

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","created":1677858242,"model":"HY-3-Preview","choices":[{"index":0,"delta":{"content":"容"},"finish_reason":null}]}

data: [DONE]

错误响应

{
  "error": {
    "message": "错误描述",
    "type": "error_type",
    "code": "error_code"
  }
}

代码生成工作流

Step 1: 确定调用上下文

分析用户需求，确定以下信息：

1. 目标语言/框架：JavaScript (fetch/axios)、TypeScript、React、Vue 等前端技术栈
2. 运行环境：必须是浏览器端（前端页面）。⚠️ 如果用户要求在后端环境中调用，必须拒绝并说明原因
3. 模型选择：当前可用模型为 HY-3-Preview（非思考模型），适用于一般对话、文本生成、内容分析等场景
4. 响应方式：是否需要流式响应（推荐用于长文本生成场景，提升用户体验）
5. 功能需求：对话、文本生成、内容分析、代码生成等

Step 2: 生成代码

根据上下文生成代码时，遵循以下规则：

1. API 地址：使用 https://ntsgw.woa.com/api/sso/llm-proxy-service/api/v1/chat/completions
2. 请求方法：必须使用 POST
3. Content-Type：必须设置为 application/json
4. ⚠️ 无需 Authorization：前端 HTTP 链路层已处理身份认证，代码中不要添加 Authorization header
5. 跨域凭证：fetch 使用 credentials: 'include'，axios 使用 withCredentials: true
6. 错误处理：代码中必须包含完善的错误处理逻辑
7. 流式处理：如需流式响应，需正确处理 SSE 数据流
8. 类型定义：TypeScript 项目中提供完整的类型定义

Step 3: 代码模板参考

生成代码时参考 references/code_templates.md 中的完整模板。

关键模板列表：

• JavaScript fetch（非流式）
• JavaScript fetch（流式/SSE）
• JavaScript axios
• TypeScript fetch（含类型定义）
• React Hook 封装（非流式）
• React Hook 封装（流式）
• Vue 3 Composable 封装

Step 4: 输出代码

将生成的代码直接写入用户项目中的目标文件，或以代码块形式展示给用户。

注意事项

1. ⚠️ 仅限前端页面调用：模型代理接口依赖前端 HTTP 链路层的 SSO 身份信息，后端环境无法正确认证
2. 无需 Authorization：身份认证由前端链路层自动处理，代码中不要手动添加
3. 模型选择建议：当前统一使用 HY-3-Preview（非思考模型），适用于常规对话、文本生成、内容分析等场景
4. 流式响应建议：长文本生成场景推荐使用流式响应，逐字返回提升用户体验
5. Token 限制：建议设置合理的 max_tokens 避免过长响应导致超时
6. 多轮对话：保持对话上下文时，需在 messages 数组中包含历史消息
7. 生成代码时，优先参考 references/code_templates.md 中的模板，确保代码风格统一

常见使用场景

场景一：简单问答

const messages = [
  { role: 'user', content: '请解释一下什么是微服务架构？' }
];

场景二：带系统提示的对话

const messages = [
  { role: 'system', content: '你是一个专业的HR助手，专门解答员工关于公司政策的问题。' },
  { role: 'user', content: '请问年假是怎么计算的？' }
];

场景三：多轮对话

const messages = [
  { role: 'system', content: '你是一个编程助手' },
  { role: 'user', content: '如何用JavaScript实现防抖函数？' },
  { role: 'assistant', content: '防抖函数的实现如下...' },
  { role: 'user', content: '能给一个使用示例吗？' }
];

场景四：复杂分析任务

const payload = {
  model: 'HY-3-Preview',
  messages: [
    { role: 'user', content: '分析这段代码的时间复杂度和空间复杂度，并提出优化建议...' }
  ],
  temperature: 0.3  // 复杂分析建议使用较低温度
};