菜单

用户界面

相关源文件

本文概述了与 Open Interpreter 交互的不同方式。系统提供三种主要的接口选项:命令行界面(CLI)、Python API 和服务器模式,每种都针对不同的用例和环境而设计。

有关这些接口连接到的核心架构的信息,请参阅核心架构

用户界面概述

Open Interpreter 提供了三种与核心功能交互的不同方式,每种方式都连接到相同的底层解释器引擎,但提供了不同的界面范式

来源:README.md44-46 README.md76-91 README.md317-349

每个接口都提供对核心功能的访问,但设计用于不同的用例

接口最佳用途主要功能
命令行交互式探索,快速任务带Markdown渲染的终端UI
Python API集成到应用程序,自定义程序化控制,流式响应
服务器模式Web应用程序,分布式系统HTTP/WebSocket 端点,异步操作

接口工作流程比较

下图说明了数据如何通过每种接口类型流动

来源:README.md126-160 README.md317-346

命令行界面 (CLI)

命令行界面提供了一个功能丰富的基于终端的用户界面,具有 Markdown 渲染和语法高亮,适用于交互式会话。

基本用法

要开始交互式聊天会话

使用 CLI 时,消息和代码输出使用 MessageBlock 类进行渲染,该类处理 Markdown 格式以及区分常规消息和代码块。

来源:README.md76-82 interpreter/terminal_interface/components/message_block.py10-28

命令行选项

CLI 支持各种选项来自定义行为

选项描述示例
--model指定要使用的语言模型interpreter --model gpt-3.5-turbo
--local使用本地语言模型interpreter --local
--api_base指定自定义API端点interpreter --api_base "http://:1234/v1"
--api_key为语言模型提供API密钥interpreter --api_key "your-key-here"
--context_window设置上下文窗口大小(令牌)interpreter --context_window 3000
--max_tokens设置响应的最大令牌数interpreter --max_tokens 1000
--verbose启用详细日志记录interpreter --verbose
-y自动确认代码执行interpreter -y
--profile使用特定的配置文件interpreter --profile my_profile.yaml

来源:README.md196-200 README.md217-229 README.md258-266 README.md269-280

交互模式命令

在交互式会话期间,可以使用特殊命令

命令描述
%verbose [true/false]切换详细模式
%reset重置对话历史记录
%undo移除上一条消息和响应
%tokens [prompt]计算令牌使用量和估计成本
%help显示可用命令

来源:README.md282-294

配置文件

CLI 支持存储为 YAML 文件的配置文件

来源:README.md295-316

Python API

Python API 提供对 Open Interpreter 的程序化控制,允许集成到 Python 应用程序中。

基本用法

来源:README.md84-91

主要方法和属性

方法/属性描述
interpreter.chat(message)发送消息并获取响应
interpreter.messages访问对话历史
interpreter.system_message自定义系统指令
interpreter.llm.model设置语言模型
interpreter.auto_run切换自动代码执行
interpreter.reset()重置对话历史

来源:README.md149-160 README.md181-190

流式响应

Python API 支持流式响应以进行实时输出处理

来源:README.md116-123 README.md139-146

管理对话状态

保存和恢复对话

来源:README.md170-179

服务器模式

服务器模式可以通过 HTTP 和 WebSocket 端点使用 Open Interpreter,非常适合 Web 应用程序和分布式系统。

来源:README.md317-346

启动服务器

启动服务器最简单的方法

自定义服务器实现

使用 FastAPI 创建自定义服务器

来源:README.md322-346

可用端点

使用 interpreter.server() 时,以下端点可用

端点方法描述
/WebSocket通过 WebSocket 进行交互式聊天
/settingsGET/POST获取或更新服务器设置
/runPOST直接执行代码
/openai/chat/completionsPOSTOpenAI 兼容的聊天端点

来源:README.md348-349

接口选择指南

在决定使用哪个接口时,请考虑您的具体需求

用例推荐接口推理
快速探索CLI易于启动,功能丰富的终端用户界面
集成到 Python 项目Python API直接访问所有功能
与 Web 应用程序集成服务器模式HTTP/WebSocket 端点
自动化处理Python API控制流和错误处理
多用户访问服务器模式具有多个客户端的集中式服务
实时交互式应用程序服务器模式 + WebSockets双向通信

来源:README.md33-53 README.md76-91 README.md317-346

集成示例

为了帮助您了解如何将 Open Interpreter 集成到您的工作流程中,以下是每种接口的典型使用模式

用于数据分析的 CLI

用于自定义应用程序的 Python API

用于 Web 应用程序的服务器模式

来源:README.md76-160 README.md317-346

总而言之,Open Interpreter 提供了一系列灵活的接口,适用于不同的环境和需求,从简单的命令行探索到集成到复杂的 Web 应用程序。所有接口都连接到同样强大的核心功能,让您可以选择最适合特定用例的接口。