Skip to content

Commit

Permalink
docs: optimize docs and fix ai test (#325)
Browse files Browse the repository at this point in the history
  • Loading branch information
zhoushaw authored Jan 25, 2025
1 parent 2811f15 commit 4b0aae2
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 12 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,15 @@ The following recorded example video is based on the [UI-TARS 7B SFT](https://hu
From version v0.10.0, we support a new open-source model named [`UI-TARS`](https://github.com/bytedance/ui-tars). Read more about it in [Choose a model](https://midscenejs.com/choose-a-model).

## 💡 Features

- **Natural Language Interaction 👆**: Describe the steps, and let Midscene plan and control the user interface for you
- **Understand UI, Answer in JSON 🔍**: Provide prompts regarding the desired data format, and then receive the expected response in JSON format.
- **Intuitive Assertion 🤔**: Make assertions in natural language; it’s all based on AI understanding.
- **Experience by Chrome Extension 🖥️**: Start immediately with the Chrome Extension. No code is needed while exploring.
- **Visualized Report for Debugging 🎞️**: With our visualized report file, you can easily understand and debug the whole process.
- **Totally Open Source! 🔥**: Experience a whole new world of automation development. Enjoy!
- **Natural Language Interaction 👆**: Just describe your goals and steps, and Midscene will plan and operate the user interface for you.
- **Chrome Extension Experience 🖥️**: Start experiencing immediately through the Chrome extension, no coding required.
- **Puppeteer/Playwright Integration 🔧**: Supports Puppeteer and Playwright integration, allowing you to combine AI capabilities with these powerful automation tools for easy automation.
- **Support Private Deployment 🤖**: Supports private deployment of [`UI-TARS`](https://github.com/bytedance/ui-tars) model, which outperforms closed-source models like GPT-4o and Claude in UI automation scenarios while better protecting data security.
- **Support General Models 🌟**: Supports general large models like GPT-4o and Claude, adapting to various scenario needs.
- **Visual Reports for Debugging 🎞️**: Through our test reports and Playground, you can easily understand, replay and debug the entire process.
- **Completely Open Source 🔥**: Experience a whole new automation development experience, enjoy!
- **Understand UI, JSON Format Responses 🔍**: You can specify data format requirements and receive responses in JSON format.
- **Intuitive Assertions 🤔**: Express your assertions in natural language, and AI will understand and process them.

## ✨ Model Choices

Expand Down
11 changes: 7 additions & 4 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,15 @@ Midscene.js 是一个由 AI 驱动的自动化 SDK,能够使用自然语言对

## 💡 特性

- **自然语言互动 👆**:只需描述你的步骤,Midscene 会为你规划和操作用户界面
- **理解UI、JSON格式回答 🔍**:你可以提出关于数据格式的要求,然后得到 JSON 格式的预期回应。
- **直观断言 🤔**:用自然语言表达你的断言,AI 会理解并处理。
- **自然语言互动 👆**:只需描述你的目标和步骤,Midscene 会为你规划和操作用户界面。
- **Chrome 插件体验 🖥️**:通过 Chrome 插件,你可以立即开始体验,无需编写代码。
- **用可视化报告来调试 🎞️**:通过我们的测试报告和 Playground,你可以轻松理解和调试整个过程。
- **Puppeteer/Playwright 集成 🔧**:支持 Puppeteer 和 Playwright 集成,让你能够结合 AI 能力和这些自动化工具的强大功能,轻松实现自动化操作。
- **支持私有化部署 🤖**:支持私有化部署 [`UI-TARS`](https://github.com/bytedance/ui-tars) 模型,相比 GPT-4o、Claude 等闭源模型,不仅在 UI 自动化场景下表现更加出色,还能更好地保护数据安全。
- **支持通用模型 🌟**:支持 GPT-4o、Claude 等通用大模型,适配多种场景需求。
- **用可视化报告来调试 🎞️**:通过我们的测试报告和 Playground,你可以轻松理解、回放和调试整个过程。
- **完全开源 🔥**:体验全新的自动化开发体验,尽情享受吧!
- **理解UI、JSON格式回答 🔍**:你可以提出关于数据格式的要求,然后得到 JSON 格式的预期回应。
- **直观断言 🤔**:用自然语言表达你的断言,AI 会理解并处理。

## ✨ 选择 AI 模型

Expand Down
2 changes: 1 addition & 1 deletion packages/midscene/tests/ai/evaluate/assertion.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ describe('ai inspect element', () => {
console.log('assertion passed, thought:', result?.content?.thought);
},
{
timeout: 30 * 1000,
timeout: 60 * 1000,
},
);
});
Expand Down

0 comments on commit 4b0aae2

Please sign in to comment.