dstackAI模型页面代码片段优化实践

在dstackAI项目的模型页面中，代码片段展示是开发者快速上手API调用的重要参考。近期社区发现并修复了一些影响开发者体验的问题，这些改进对于API接口的规范性和易用性具有重要意义。

Python代码片段优化

原Python代码片段存在缩进不一致的问题，混合使用了2空格和4空格缩进。规范的Python代码应遵循PEP 8指南，统一使用4空格缩进。修复后的代码片段更加规范：

response = client.chat.completions.create(
    model="meta-llama/Meta-Llama-3.1-8B-Instruct",
    messages=[
        {
            "role": "user",
            "content": "Hello world"
        }
    ],
    stream=True,
    max_tokens=512
)

此外，还修复了JSON对象中缺失的逗号问题，确保代码可以直接复制使用而不会出现语法错误。

cURL请求优化

cURL示例中发现了两个关键问题：

1. URL拼接问题：基础URL和路径之间缺少斜杠分隔符。解决方案是智能处理基础URL的结尾，无论是否已有斜杠都能正确拼接：

curl https://gateway.example.com/chat/completions \

2. JSON格式问题：修复了JSON对象末尾的非法逗号，确保请求体是有效的JSON格式：

  -d '{
  "model": "meta-llama/Meta-Llama-3.1-8B-Instruct",
  "messages": [
    {
      "role": "user",
      "content": "Hello world"
    }
  ],
  "stream": true,
  "max_tokens": 512
}'

新增消息示例

为避免开发者遇到模糊的错误信息，代码片段中新增了完整的消息结构示例。这对于新手特别有帮助，可以避免因消息格式不正确导致的API调用失败。例如TGI实现可能会因为缺少消息而返回难以理解的模板错误。

兼容性考虑

移除了curl示例中的response_format参数，因为发现并非所有后端实现都支持该参数。这一改动提高了代码片段在不同实现间的兼容性，确保开发者能够获得一致的体验。

这些优化虽然看似细小，但对于提升开发者体验至关重要。规范的代码示例能减少开发者的调试时间，帮助他们更快地将dstackAI集成到自己的应用中。项目团队对这些问题的快速响应也体现了对开发者体验的重视。