> ## 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.

# 将 AI SDK 与 CometAPI 一起使用

> 使用本指南通过设置 base URL、API key 以及 model 或 provider 选项，将 AI SDK 配置为使用 CometAPI。

[AI SDK 的 CometAPI provider](https://github.com/cometapi-dev/ai-sdk-provider) 通过统一的 TypeScript 接口为你提供对 500+ AI 模型的访问。使用它可以为任何 Node.js 或 Edge 运行时应用添加文本生成、流式输出、嵌入和图像生成功能。

## 支持的功能

| 功能     | 方法                     | 状态  |
| ------ | ---------------------- | --- |
| 文本生成   | `generateText()`       | 已支持 |
| 文本流式输出 | `streamText()`         | 已支持 |
| 文本嵌入   | `textEmbeddingModel()` | 已支持 |
| 图像生成   | `imageModel()`         | 已支持 |

## 前提条件

* Node.js 18+
* 一个拥有有效 API key 的 CometAPI 账户 — [在此获取](https://www.cometapi.com/console/token)

<Steps>
  <Step title="安装 provider">
    安装 `@cometapi/ai-sdk-provider` 以及 AI SDK 核心包：

    <CodeGroup>
      ```bash npm theme={null}
      npm install @cometapi/ai-sdk-provider ai
      ```

      ```bash pnpm theme={null}
      pnpm add @cometapi/ai-sdk-provider ai
      ```

      ```bash yarn theme={null}
      yarn add @cometapi/ai-sdk-provider ai
      ```
    </CodeGroup>
  </Step>

  <Step title="设置你的 API key">
    该 provider 默认会读取 `COMETAPI_KEY` 环境变量：

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

    <Note>
      使用环境变量可避免将凭据硬编码到源代码中。
    </Note>
  </Step>

  <Step title="导入 provider">
    导入默认的 provider 实例：

    ```typescript theme={null}
    import { cometapi } from '@cometapi/ai-sdk-provider';
    ```

    如需覆盖 API key、base URL 或其他设置，请使用 `createCometAPI`：

    ```typescript theme={null}
    import { createCometAPI } from '@cometapi/ai-sdk-provider';

    const cometapi = createCometAPI({
      apiKey: process.env.COMETAPI_KEY,       // override env variable
      baseURL: 'https://api.cometapi.com/v1',  // default
    });
    ```
  </Step>
</Steps>

## 用法

### 生成文本

使用 `generateText()` 获取一次性响应：

```typescript theme={null}
import { cometapi } from '@cometapi/ai-sdk-provider';
import { generateText } from 'ai';

const { text } = await generateText({
  model: cometapi('your-model-id'),
  prompt: 'What is CometAPI?',
});

console.log(text);
```

### 流式输出文本

使用 `streamText()` 获取实时分块输出：

```typescript theme={null}
import { cometapi } from '@cometapi/ai-sdk-provider';
import { streamText } from 'ai';

const result = streamText({
  model: cometapi('your-model-id'),
  prompt: 'Write a short story about AI.',
});

for await (const chunk of result.textStream) {
  process.stdout.write(chunk);
}
```

### 生成嵌入

使用 `textEmbeddingModel()` 创建向量嵌入：

```typescript theme={null}
import { cometapi } from '@cometapi/ai-sdk-provider';

const model = cometapi.textEmbeddingModel('text-embedding-3-small');

// Single embedding
const single = await model.doEmbed({ values: ['Hello, world!'] });
console.log('Dimensions:', single.embeddings[0].length);

// Batch embeddings
const batch = await model.doEmbed({
  values: ['sunny day', 'rainy afternoon', 'cold winter night'],
});
console.log('Count:', batch.embeddings.length);
```

### 生成图像

使用 `imageModel()` 根据文本 Prompt 生成图像：

```typescript theme={null}
import { cometapi } from '@cometapi/ai-sdk-provider';
import { experimental_generateImage as generateImage } from 'ai';

const { image } = await generateImage({
  model: cometapi.imageModel('your-model-id'),
  prompt: 'A beautiful sunset over mountains',
});
```

## 提供商配置

`createCometAPI` 接受以下选项：

| 选项        | 类型                       | 默认值                           | 描述              |
| --------- | ------------------------ | ----------------------------- | --------------- |
| `apiKey`  | `string`                 | `process.env.COMETAPI_KEY`    | CometAPI API 密钥 |
| `baseURL` | `string`                 | `https://api.cometapi.com/v1` | API 基础 URL      |
| `headers` | `Record<string, string>` | —                             | 自定义请求头          |
| `fetch`   | `FetchFunction`          | —                             | 自定义 fetch 实现    |

## 模型方法

该提供商暴露了多个模型构造函数：

| 方法                                     | 返回值                | 使用场景            |
| -------------------------------------- | ------------------ | --------------- |
| `cometapi(modelId)`                    | `LanguageModelV2`  | 文本生成和流式输出（简写）   |
| `cometapi.chatModel(modelId)`          | `LanguageModelV2`  | 聊天补全            |
| `cometapi.completionModel(modelId)`    | `LanguageModelV2`  | 文本补全            |
| `cometapi.languageModel(modelId)`      | `LanguageModelV2`  | `chatModel` 的别名 |
| `cometapi.textEmbeddingModel(modelId)` | `EmbeddingModelV2` | 文本嵌入            |
| `cometapi.imageModel(modelId)`         | `ImageModelV2`     | 图像生成            |

在[模型页面](/zh-Hans/overview/models)浏览可用 model ID 的完整列表。

<AccordionGroup>
  <Accordion title="提示与故障排查">
    * **模型选择**：来自 [CometAPI 模型目录](/zh-Hans/overview/models) 的任何模型都可与对应的模型方法配合使用——聊天模型使用 `cometapi()`，嵌入模型使用 `textEmbeddingModel()`，图像模型使用 `imageModel()`。
    * **微调响应**：将 `temperature`、`maxTokens` 和 `topP` 直接传递给 `generateText()` 或 `streamText()`，例如 `generateText(\{..., temperature: 0.7\})`。
    * **错误处理**：将调用包装在 `try/catch` 中，以处理身份验证错误、速率限制或网络问题。
    * **安全性**：不要将 API 密钥提交到版本控制。请使用环境变量或密钥管理器。
    * **速率限制**：在 [CometAPI 控制台](https://www.cometapi.com/console) 中监控使用情况。
  </Accordion>
</AccordionGroup>

## 相关资源

* [GitHub 上的 CometAPI AI SDK Provider](https://github.com/cometapi-dev/ai-sdk-provider)
* [npm 上的 @cometapi/ai-sdk-provider](https://www.npmjs.com/package/@cometapi/ai-sdk-provider)
* [AI SDK 文档](https://ai-sdk.dev/docs)
* [CometAPI 快速开始](/zh-Hans/overview/quick-start)

<script type="application/ld+json">
  {`
    {
    "@context": "https://schema.org",
    "@graph": [
      {
        "@type": "HowTo",
        "@id": "https://apidoc.cometapi.com/integrations/ai-sdk#howto",
        "name": "将 AI SDK 与 CometAPI 一起使用",
        "description": "使用本指南通过设置 base URL、API key 以及 model 或 provider 选项来配置 AI SDK 与 CometAPI 的集成。",
        "step": [
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/integrations/ai-sdk#step-1",
            "position": 1,
            "name": "安装 provider",
            "text": "完成“将 AI SDK 与 CometAPI 一起使用”指南中的“安装 provider”步骤。"
          },
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/integrations/ai-sdk#step-2",
            "position": 2,
            "name": "设置你的 API key",
            "text": "将你的 CometAPI API key 存储在该集成所使用的环境变量或设置字段中。"
          },
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/integrations/ai-sdk#step-3",
            "position": 3,
            "name": "导入 provider",
            "text": "完成“将 AI SDK 与 CometAPI 一起使用”指南中的“导入 provider”步骤。"
          }
        ]
      },
      {
        "@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": "将 AI SDK 与 CometAPI 一起使用",
            "item": "https://apidoc.cometapi.com/integrations/ai-sdk"
          }
        ]
      }
    ]
    }
    `}
</script>