Skip to content

Commit 07e0d50

Browse files
committed
docs: udpate readme
1 parent 7d143b6 commit 07e0d50

File tree

2 files changed

+62
-27
lines changed

2 files changed

+62
-27
lines changed

README.cn.md

+11
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,17 @@ AI Agent 脚本引擎特点:
4444
* [PPE 的 智能编程指南](./lib/guide/)
4545
* 在项目根目录下运行 `ai run guide --streamEcho line` 来启动指南
4646
* [人工智能终端 shell](https://github.com/offline-ai/ai-shell)
47+
* LLM 推理提供者:
48+
* `llamacpp`: llama.cpp server 作为默认的本地 LLM 提供者. 如果没有提供`provider`,就是`llamacpp`
49+
* `openai`: 也支持 OpenAI兼容 服务 API 提供者.
50+
* `--provider openai://chatgpt-4o-latest --apiKey “sk-XXX”`
51+
52+
注意: OpenAI兼容 服务 API 提供者的限制
53+
54+
1. OpenAI 必须是`gpt-4o` `2024-07-18`之后的大模型才支持(json-schema)。在此之前,仅能保证 `json` 支持,无法保证schema.
55+
2. `siliconflow` 的所有模型只保证json,不保证schema.
56+
* `--provider openai://Qwen/Qwen2.5-Coder-7B-Instruct -u https://api.siliconflow.cn/ --apiKey “sk-XXX” ...`
57+
3. `[[Fruit:|Apple|Banana]]`: 让AI强制单选或多选语法,将失效
4758

4859
### Install
4960

README.md

+51-27
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,16 @@ Developing an intelligent application with AI Agent Script Engine involves just
5454
* [AI Guide App For PPE Guide](./lib/guide/) - WIP
5555
* `ai run guide --streamEcho line` in the project root folder to run the guide
5656
* [AI Terminal Shell](https://github.com/offline-ai/ai-shell)
57+
* LLM Inference Providers:
58+
* `llamacpp`: llama.cpp server as the default local LLM provider. If no `provider` is specified, `llamacpp` is used.
59+
* `openai`: Also supports OpenAI-compatible service API providers.
60+
* `--provider openai://chatgpt-4o-latest --apiKey “sk-XXX”`
61+
62+
Note: Limitations of OpenAI-Compatible Service API Providers
63+
64+
1. OpenAI must be a large model (`gpt-4o`) released after `2024-07-18` to support `json-schema`. Before this date, only `json` is guaranteed, not the `json-schema`.
65+
2. All `siliconflow` models only guarantee `json` support, not `json-schema` support.
66+
3. `[[Fruit:|Apple|Banana]]`: Syntax for forcing AI to choose either Apple or Banana will be invalid.
5767

5868
## [PPE CLI Command](./lib/guide/cli.md)
5969

@@ -171,7 +181,7 @@ $ npm install -g @offline-ai/cli
171181
$ ai COMMAND
172182
running command...
173183
$ ai (--version)
174-
@offline-ai/cli/0.5.6 linux-x64 node-v20.17.0
184+
@offline-ai/cli/0.5.7 linux-x64 node-v20.17.0
175185
$ ai --help [COMMAND]
176186
USAGE
177187
$ ai COMMAND
@@ -349,31 +359,45 @@ Specific script instruction manual see: [Programmable Prompt Engine Specificatio
349359
# Commands
350360

351361
<!-- commands -->
352-
* [`ai agent`](#ai-agent)
353-
* [`ai autocomplete [SHELL]`](#ai-autocomplete-shell)
354-
* [`ai brain [NAME]`](#ai-brain-name)
355-
* [`ai brain dn [NAME]`](#ai-brain-dn-name)
356-
* [`ai brain down [NAME]`](#ai-brain-down-name)
357-
* [`ai brain download [NAME]`](#ai-brain-download-name)
358-
* [`ai brain list [NAME]`](#ai-brain-list-name)
359-
* [`ai brain refresh`](#ai-brain-refresh)
360-
* [`ai brain search [NAME]`](#ai-brain-search-name)
361-
* [`ai config [ITEM_NAME]`](#ai-config-item_name)
362-
* [`ai config save [DATA]`](#ai-config-save-data)
363-
* [`ai help [COMMAND]`](#ai-help-command)
364-
* [`ai plugins`](#ai-plugins)
365-
* [`ai plugins add PLUGIN`](#ai-plugins-add-plugin)
366-
* [`ai plugins:inspect PLUGIN...`](#ai-pluginsinspect-plugin)
367-
* [`ai plugins install PLUGIN`](#ai-plugins-install-plugin)
368-
* [`ai plugins link PATH`](#ai-plugins-link-path)
369-
* [`ai plugins remove [PLUGIN]`](#ai-plugins-remove-plugin)
370-
* [`ai plugins reset`](#ai-plugins-reset)
371-
* [`ai plugins uninstall [PLUGIN]`](#ai-plugins-uninstall-plugin)
372-
* [`ai plugins unlink [PLUGIN]`](#ai-plugins-unlink-plugin)
373-
* [`ai plugins update`](#ai-plugins-update)
374-
* [`ai run [FILE] [DATA]`](#ai-run-file-data)
375-
* [`ai test`](#ai-test)
376-
* [`ai version`](#ai-version)
362+
- [Offline AI PPE CLI(WIP)](#offline-ai-ppe-cliwip)
363+
- [Quick Start](#quick-start)
364+
- [PPE CLI Command](#ppe-cli-command)
365+
- [Programmable Prompt Engine Language](#programmable-prompt-engine-language)
366+
- [I. Core Structure](#i-core-structure)
367+
- [II. Reusability \& Configuration](#ii-reusability--configuration)
368+
- [III. AI Capabilities](#iii-ai-capabilities)
369+
- [IV. Message Text Formatting](#iv-message-text-formatting)
370+
- [V. Script Capabilities](#v-script-capabilities)
371+
- [Install](#install)
372+
- [Run](#run)
373+
- [Usage](#usage)
374+
- [Commands](#commands)
375+
- [`ai agent`](#ai-agent)
376+
- [`ai autocomplete [SHELL]`](#ai-autocomplete-shell)
377+
- [`ai brain [NAME]`](#ai-brain-name)
378+
- [`ai brain dn [NAME]`](#ai-brain-dn-name)
379+
- [`ai brain down [NAME]`](#ai-brain-down-name)
380+
- [`ai brain download [NAME]`](#ai-brain-download-name)
381+
- [`ai brain list [NAME]`](#ai-brain-list-name)
382+
- [`ai brain refresh`](#ai-brain-refresh)
383+
- [`ai brain search [NAME]`](#ai-brain-search-name)
384+
- [`ai config [ITEM_NAME]`](#ai-config-item_name)
385+
- [`ai config save [DATA]`](#ai-config-save-data)
386+
- [`ai help [COMMAND]`](#ai-help-command)
387+
- [`ai plugins`](#ai-plugins)
388+
- [`ai plugins add PLUGIN`](#ai-plugins-add-plugin)
389+
- [`ai plugins:inspect PLUGIN...`](#ai-pluginsinspect-plugin)
390+
- [`ai plugins install PLUGIN`](#ai-plugins-install-plugin)
391+
- [`ai plugins link PATH`](#ai-plugins-link-path)
392+
- [`ai plugins remove [PLUGIN]`](#ai-plugins-remove-plugin)
393+
- [`ai plugins reset`](#ai-plugins-reset)
394+
- [`ai plugins uninstall [PLUGIN]`](#ai-plugins-uninstall-plugin)
395+
- [`ai plugins unlink [PLUGIN]`](#ai-plugins-unlink-plugin)
396+
- [`ai plugins update`](#ai-plugins-update)
397+
- [`ai run [FILE] [DATA]`](#ai-run-file-data)
398+
- [`ai test`](#ai-test)
399+
- [`ai version`](#ai-version)
400+
- [Credit](#credit)
377401

378402
## `ai agent`
379403

@@ -401,7 +425,7 @@ EXAMPLES
401425
$ ai agent publish <agent-name>
402426
```
403427

404-
_See code: [src/commands/agent/index.ts](https://github.com/offline-ai/cli/blob/v0.5.6/src/commands/agent/index.ts)_
428+
_See code: [src/commands/agent/index.ts](https://github.com/offline-ai/cli/blob/v0.5.7/src/commands/agent/index.ts)_
405429

406430
## `ai autocomplete [SHELL]`
407431

0 commit comments

Comments
 (0)