> ## Documentation Index
> Fetch the complete documentation index at: https://apidoc.cometapi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 将 Promptfoo 与 CometAPI 配合使用

> 使用本指南通过设置 base URL、API key，以及 model 或 provider 选项来配置 Promptfoo 与 CometAPI 的集成。

[Promptfoo](https://www.promptfoo.dev/) 是一个用于 Prompt 评估、回归测试和 AI 红队测试的框架。Promptfoo 包含一个 `cometapi` provider，可通过与 OpenAI 兼容的端点调用 CometAPI。

## 前提条件

* Node.js 18+
* 已在本地安装 Promptfoo，或通过 `npx` 运行
* 一个拥有有效 API key 的 CometAPI 账户 —— [在控制台中获取](https://www.cometapi.com/console/token)
* 来自 [CometAPI Models 页面](/zh-Hans/overview/models) 的 model ID

## 配置集成

<Steps>
  <Step title="设置你的 CometAPI API key">
    在运行评估之前设置 `COMETAPI_KEY`：

    ```bash theme={null}
    read -rsp "CometAPI API key: " COMETAPI_KEY
    printf '\n'
    export COMETAPI_KEY
    ```
  </Step>

  <Step title="选择 provider 格式">
    Promptfoo 对 CometAPI 使用以下 provider ID 格式：

    ```yaml theme={null}
    providers:
      - cometapi:<type>:<model>
    ```

    使用以下 provider 类型：

    | Type         | 使用场景                          |
    | ------------ | ----------------------------- |
    | `chat`       | 聊天补全、视觉和多模态（Multimodal）Prompt |
    | `completion` | 文本补全模型                        |
    | `embedding`  | 文本嵌入评估                        |
    | `image`      | 图像生成评估                        |

    你也可以使用 `cometapi:your-model-id` 作为默认聊天模式。
  </Step>

  <Step title="运行 CLI 评估">
    以下命令会运行一次单 Prompt 的聊天评估：

    ```bash theme={null}
    npx promptfoo@latest eval \
      --prompts "Write a concise release note for {{feature}}" \
      --vars feature="a unified API dashboard" \
      -r cometapi:chat:your-model-id
    ```
  </Step>

  <Step title="创建 Promptfoo 配置文件">
    以下 `promptfooconfig.yaml` 会使用 CometAPI 模型评估相同的 Prompt：

    ```yaml theme={null}
    prompts:
      - "Classify this support request: {{message}}"

    providers:
      - id: cometapi:chat:your-model-id
        config:
          temperature: 0.2
          max_tokens: 256

    tests:
      - vars:
          message: "The API key works locally but fails in production."
        assert:
          - type: contains-any
            value:
              - authentication
              - configuration
    ```

    使用 Promptfoo 运行该配置文件：

    ```bash theme={null}
    npx promptfoo@latest eval -c promptfooconfig.yaml
    ```
  </Step>
</Steps>

## Provider 示例

使用与你想要评估的模型行为相匹配的 provider 类型：

```yaml theme={null}
providers:
  - cometapi:chat:your-model-id
  - cometapi:completion:your-model-id
  - cometapi:embedding:your-model-id
  - cometapi:image:your-model-id
```

对于多模态测试，请保留 `chat` provider 类型，并通过 Promptfoo 测试变量传递图像变量。

## 故障排查

<AccordionGroup>
  <Accordion title="Promptfoo 找不到 API key">
    确认 `COMETAPI_KEY` 已在运行 `promptfoo eval` 的同一个 shell 会话中导出。
  </Accordion>

  <Accordion title="provider 类型与模型不匹配">
    对话式和多模态模型使用 `chat`，嵌入模型使用 `embedding`，图像生成模型使用 `image`。
  </Accordion>

  <Accordion title="model ID 无法使用">
    将 `your-model-id` 替换为来自 [CometAPI Models 页面](/zh-Hans/overview/models) 的准确 model ID。
  </Accordion>
</AccordionGroup>

## 相关资源

* [Promptfoo CometAPI 提供方](https://www.promptfoo.dev/docs/providers/cometapi/)
* [CometAPI 快速开始](/zh-Hans/overview/quick-start)
* [CometAPI 模型页面](/zh-Hans/overview/models)

<script type="application/ld+json">
  {`
    {
    "@context": "https://schema.org",
    "@graph": [
      {
        "@type": "HowTo",
        "@id": "https://apidoc.cometapi.com/integrations/promptfoo#howto",
        "name": "使用 Promptfoo 与 CometAPI",
        "description": "使用本指南通过设置 base URL、API key 以及 model 或 provider 选项来配置 Promptfoo 与 CometAPI。",
        "step": [
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/integrations/promptfoo#step-1",
            "position": 1,
            "name": "设置你的 CometAPI API key",
            "text": "将你的 CometAPI API key 存储在该集成所使用的环境变量或设置字段中。"
          },
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/integrations/promptfoo#step-2",
            "position": 2,
            "name": "选择 provider 格式",
            "text": "完成“使用 Promptfoo 与 CometAPI”指南中的“选择 provider 格式”步骤。"
          },
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/integrations/promptfoo#step-3",
            "position": 3,
            "name": "运行 CLI 评估",
            "text": "完成“使用 Promptfoo 与 CometAPI”指南中的“运行 CLI 评估”步骤。"
          },
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/integrations/promptfoo#step-4",
            "position": 4,
            "name": "创建 Promptfoo 配置文件",
            "text": "完成“使用 Promptfoo 与 CometAPI”指南中的“创建 Promptfoo 配置文件”步骤。"
          }
        ]
      },
      {
        "@type": "BreadcrumbList",
        "itemListElement": [
          {
            "@type": "ListItem",
            "position": 1,
            "name": "CometAPI 文档",
            "item": "https://apidoc.cometapi.com/"
          },
          {
            "@type": "ListItem",
            "position": 2,
            "name": "集成",
            "item": "https://apidoc.cometapi.com/integrations"
          },
          {
            "@type": "ListItem",
            "position": 3,
            "name": "使用 Promptfoo 与 CometAPI",
            "item": "https://apidoc.cometapi.com/integrations/promptfoo"
          }
        ]
      }
    ]
    }
    `}
</script>