Skip to content

Commit

Permalink
Add folder creation and requirements to README
Browse files Browse the repository at this point in the history
  • Loading branch information
ae86jack committed Mar 18, 2024
1 parent c2517e7 commit 78bd12a
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 6 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ AI-zhipu is an Obsidian plugin that helps you utilize the Zhipu API to generate

## How to use

- When the plugin is initialized, it will automatically create a folder `Aizhipu` in the vault directory, and create prompt template files, with both Chinese and English templates.
- Register an account on the [ZhiPu website](https://open.bigmodel.cn), obtain the API key, and enter it into the plugin settings.
- Enter edit mode
- Select the prompt, and activate the command "Generate from the selected text / line / block" , then select the prompt template.
Expand All @@ -25,6 +26,12 @@ AI-zhipu is an Obsidian plugin that helps you utilize the Zhipu API to generate

![image](docs/images/show_chat_detail.png)

## Requirements

- An API key from [ZhiPu AI](https://open.bigmodel.cn)
- network connection when using the command "Generate from the selected text / line / block"
- Using the ZhiPu API will incur charges. For detailed fee information, please refer to the [official ZhiPu website](https://open.bigmodel.cn). It is important to note that generating images from text consumes a significant number of tokens.

## Install from Github

1. From the release page, download `manifest.json` and `main.js` to `<vault>/.obsidian/plugins/ai-zhipu`
Expand Down
19 changes: 13 additions & 6 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@

# 简介

Ai-zhipu 是一个obsidian的插件,帮助你使用智谱API, 生成内容、文生图、基于知识库问答等等AI能力,你可以定制提示词模板,基于智谱AI来打造你的专属知识管理系统
Ai-zhipu 是一个 obsidian 的插件,帮助你使用智谱 API, 生成内容、文生图、基于知识库问答等等 AI 能力,你可以定制提示词模板,基于智谱 AI 来打造你的专属知识管理系统

## 如何使用

-[智谱网站](https://open.bigmodel.cn)注册账号,获取API key,填入插件设置中
- 插件初始化时,会自动在 vault 的目录下创建一个文件夹 `Aizhipu`,创建提示词模板文件,有中英文两种模板。
-[智谱网站](https://open.bigmodel.cn)注册账号,获取 API key,填入插件设置中
- 进入编辑模式
- 选中提示词,启动命令“生成内容(基于选中的文本、行、区块)”,选择提示词模板

Expand All @@ -21,12 +22,18 @@ Ai-zhipu 是一个obsidian的插件,帮助你使用智谱API, 生成内容、

![image](docs/images/zh/选取区块.gif)

- 在对话详情中查看上次对话的详情,详情包括提示词、tokens使用情况
- 在对话详情中查看上次对话的详情,详情包括提示词、tokens 使用情况

![image](docs/images/zh/显示对话详情.png)

## 从Github安装
## 要求

1. 从release页面下载`manifest.json``main.js``<vault>/.obsidian/plugins/ai-zhipu`
- [智谱 AI](https://open.bigmodel.cn) 的 API key
- 使用命令“生成内容(基于选中的文本、行、区块)”时需要网络连接
- 智谱 API 调用会产生费用,具体费用请参考[智谱官网](https://open.bigmodel.cn)。需要注意的是,文生图的 tokens 消耗较大。

## 从 Github 安装

1. 从 release 页面下载 `manifest.json``main.js``<vault>/.obsidian/plugins/ai-zhipu`
2. 刷新已安装的插件
3. 启用AI Zhipu
3. 启用 AI Zhipu

0 comments on commit 78bd12a

Please sign in to comment.