gptel 项目使用教程

gptel 项目使用教程

gptel A simple LLM client for Emacs 项目地址: https://gitcode.com/gh_mirrors/gp/gptel

1. 项目目录结构及介绍

gptel/
├── LICENSE
├── README.org
├── gptel-anthropic.el
├── gptel-context.el
├── gptel-curl.el
├── gptel-gemini.el
├── gptel-kagi.el
├── gptel-ollama.el
├── gptel-openai.el
├── gptel-org.el
├── gptel-privategpt.el
├── gptel-rewrite.el
├── gptel-transient.el
└── gptel.el

目录结构介绍

• LICENSE: 项目的许可证文件。
• README.org: 项目的说明文档，包含项目的介绍、安装方法、使用说明等。
• gptel-anthropic.el: 与 Anthropic 模型相关的配置和功能实现。
• gptel-context.el: 上下文管理相关的功能实现。
• gptel-curl.el: 使用 Curl 进行网络请求的配置和功能实现。
• gptel-gemini.el: 与 Gemini 模型相关的配置和功能实现。
• gptel-kagi.el: 与 Kagi 模型相关的配置和功能实现。
• gptel-ollama.el: 与 Ollama 模型相关的配置和功能实现。
• gptel-openai.el: 与 OpenAI 模型相关的配置和功能实现。
• gptel-org.el: 与 Org 模式相关的配置和功能实现。
• gptel-privategpt.el: 与 PrivateGPT 模型相关的配置和功能实现。
• gptel-rewrite.el: 重写功能相关的配置和功能实现。
• gptel-transient.el: 临时功能相关的配置和功能实现。
• gptel.el: 项目的主文件，包含主要的配置和功能实现。

2. 项目启动文件介绍

项目的主启动文件是 gptel.el。该文件包含了项目的核心功能和配置，是启动和使用 gptel 的关键文件。

主要功能

• 模型支持: 支持多种语言模型，包括 OpenAI、Anthropic、Gemini 等。
• 上下文管理: 支持在对话中添加和管理上下文信息。
• 流式响应: 支持流式响应，实时获取模型的输出。
• 配置管理: 提供了多种配置选项，用户可以根据需要进行自定义配置。

3. 项目配置文件介绍

项目的配置文件主要包括 gptel.el 和各个模型的配置文件（如 gptel-openai.el、gptel-anthropic.el 等）。

主要配置项

• gptel-backend: 设置默认的模型后端。
• gptel-model: 设置默认使用的模型。
• gptel-stream: 是否启用流式响应。
• gptel-api-key: 设置 API 密钥，可以是一个字符串或返回密钥的函数。
• gptel-max-tokens: 设置请求和响应的最大 token 数量。
• gptel-temperature: 设置响应的随机性，取值范围为 0 到 2。

配置示例

(setq gptel-backend "OpenAI")
(setq gptel-model "gpt-3.5-turbo")
(setq gptel-stream t)
(setq gptel-api-key "your-api-key")
(setq gptel-max-tokens 500)
(setq gptel-temperature 0.7)

通过这些配置项，用户可以根据自己的需求定制 gptel 的行为。

gptel A simple LLM client for Emacs 项目地址: https://gitcode.com/gh_mirrors/gp/gptel