Skip to content

Commit

Permalink
docs: update adapter config docs
Browse files Browse the repository at this point in the history
  • Loading branch information
RockChinQ committed Oct 16, 2023
1 parent e7ce797 commit e4624cf
Show file tree
Hide file tree
Showing 8 changed files with 113 additions and 4 deletions.
9 changes: 8 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# Free One API

[中文](/zh-CN/README.md) | [English](/en/README.md)
Welcome to the Free One API project, which is a free and open source project that provides a unified API for all reverse engineered LLM libs.

欢迎访问 Free One API 项目,这是一个免费开源的项目,提供了一个统一的 API,用于访问所有逆向工程的 LLM 库。

# 语言 Language

* [中文](/zh-CN/README.md)
* [English](/en/README.md)
2 changes: 2 additions & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* [中文文档](/zh-CN/)
* [English](/en/)
3 changes: 2 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
window.$docsify = {
name: 'free-one-api',
repo: 'https://github.com/RockChinQ/free-one-api',
loadSidebar: true
loadSidebar: true,
subMaxLevel: 3,
}
</script>
<!-- Docsify v4 -->
Expand Down
99 changes: 99 additions & 0 deletions docs/zh-CN/Adapters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# 适配器

Free One API 目前支持多种 LLM 逆向工程库,每个渠道支持对应一个适配器,适配器负责将客户端的请求转换成逆向工程库的请求,并将逆向工程库的响应转换成客户端的响应。

## acheong08/ChatGPT

ChatGPT 官网逆向工程库

### 配置方式

1. 选择 `acheong08/ChatGPT` 作为 `Adapter`

![选择适配器](assets/select_adapter.png)

2. 前往 `chat.openai.com` 登录账号

3. 直接在浏览器访问 `https://chat.openai.com/api/auth/session`, 复制得到的 `access_token`

![Alt text](assets/get_actoken.png)

4.`Config` 栏中输入

```json
{
"access_token": "你的access token"
}
```

5. 保存即可测试

## KoushikNavuluri/Claude-API

Anthropic Claude 官网逆向工程库

### 配置方式

1. 选择 `KoushikNavuluri/Claude-API` 作为 `Adapter`

2. 登录 `claude.ai`, 打开 `F12`, 选择 `Network` 栏, 找到任意一个请求, 复制请求头中的 `Cookie` 字符串

![claude_get_cookie](assets/claude_cookie.png)

3.`Config` 栏中输入

```json
{
"cookie": "你的cookie"
}
```

## xtekky/gpt4free

xtekky/gpt4free 整合了多个平台的 LLM 逆向工程库

### 配置方式

1. 选择 `xtekky/gpt4free` 作为 `Adapter`

2. 无需鉴权,直接保存即可

## Soulter/hugging-chat-api

huggingface.co/chat 官网逆向工程库

### 配置方式

1. 注册 `HuggingFace` 账号

2. 选择 `Soulter/hugging-chat-api` 作为 `Adapter`

3.`Config` 栏中输入

```json
{
"email": "HuggingFace 注册邮箱",
"passwd": "HuggingFace 密码"
}
```

## xw5xr6/revTongYi

阿里云通义千问官网逆向工程库

### 配置方式

1. 选择 `xw5xr6/revTongYi` 作为 `Adapter`

2. 前往 <https://qianwen.aliyun.com/> 登录账号并确保可以正常对话

3. 参照上方 Claude 的配置方式,获取 `Cookie` 字符串

4.`Config` 栏中输入

```json
{
"cookie": "通义千问cookie"
}
```

4 changes: 2 additions & 2 deletions docs/zh-CN/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
* [中文文档](zh-CN/)
* [English](en/)
* [首页](/zh-CN/)
* [适配器](/zh-CN/Adapters)
Binary file added docs/zh-CN/assets/claude_cookie.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/zh-CN/assets/get_actoken.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/zh-CN/assets/select_adapter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e4624cf

Please sign in to comment.