---
title: "API 参考"
description: "AI 工具包方法的完整 API 参考。"
canonical_url: "https://tiptap.zhcndoc.com/content-ai/capabilities/ai-toolkit/api-reference"
---

# API 参考

AI 工具包方法的完整 API 参考。

AI 工具包提供了一组方法，它们是您的 AI 集成的构建模块。您可以从 AI 工具包实例调用这些方法：

```ts
import { Editor } from '@tiptap/core'
import { AiToolkit, getAiToolkit } from '@tiptap-pro/ai-toolkit'

// 获取 AI 工具包实例
const editor = new Editor({ extensions: [AiToolkit] })
const toolkit = getAiToolkit(editor)

// 调用 AI 工具包方法
const text = toolkit.getTextRange({ from: 0, to: 100 })
```

以下是可用方法列表：

[读取文档
了解更多 →提取文档内容，支持 JSON、HTML 或文本格式，并支持选择、范围和分块读取。](https://tiptap.zhcndoc.com/content-ai/capabilities/ai-toolkit/api-reference/read-the-document.md)

[编辑文档
了解更多 →插入、流式传输和修补 AI 生成的内容，支持文本、HTML 或 JSON 格式，并具备审查选项。](https://tiptap.zhcndoc.com/content-ai/capabilities/ai-toolkit/api-reference/edit-the-document.md)

[执行工具
了解更多 →使用 AI 工具包对 Tiptap 编辑器执行 AI 代理工具调用。](https://tiptap.zhcndoc.com/content-ai/capabilities/ai-toolkit/api-reference/execute-tool.md)

[工作流
了解更多 →AI 工具包内置工作流的 API 参考。](https://tiptap.zhcndoc.com/content-ai/capabilities/ai-toolkit/api-reference/workflows.md)

[建议
更多 →管理和渲染 AI 建议，支持预览和审核模式。](https://tiptap.zhcndoc.com/content-ai/capabilities/ai-toolkit/api-reference/suggestions.md)

[架构感知
了解更多 →为 AI 模型提供架构感知，使其理解节点、标记和属性。](https://tiptap.zhcndoc.com/content-ai/capabilities/ai-toolkit/api-reference/schema-awareness.md)

[差异工具
了解更多 →编程方式计算两个文档之间的变更。](https://tiptap.zhcndoc.com/content-ai/capabilities/ai-toolkit/api-reference/diff-utility.md)

[拆分视图
了解更多 →createSplitView 和 SplitView 实例方法的 API 参考。](https://tiptap.zhcndoc.com/content-ai/capabilities/ai-toolkit/api-reference/split-view.md)