Bookshrink 技术文档

1. 安装指南

1.1 环境准备

在开始安装之前，请确保您的系统已经安装了以下工具和依赖：

• Git
• Python 3.x
• Make

1.2 安装步骤

1. 打开终端，克隆项目代码库：

   git clone https://github.com/peterldowns/bookshrink.git
   

2. 进入项目目录：

   cd bookshrink
   

3. 运行 make 命令进行安装：

   make
   

2. 项目的使用说明

2.1 启动服务

安装完成后，您可以通过以下步骤启动本地服务：

1. 在终端中进入项目目录：

   cd bookshrink
   

2. 运行 make 命令启动服务：

   make
   

3. 打开浏览器，访问 http://127.0.0.1:8080/，即可使用 Bookshrink 工具。

2.2 使用方法

在浏览器中打开 Bookshrink 页面后，您可以将文本粘贴到输入框中，选择输出选项（如句子数量或百分比），然后点击“分析”按钮。Bookshrink 将会提取出最具有代表性的句子，帮助您快速了解文本的核心内容。

3. 项目API使用文档

3.1 API 概述

Bookshrink 提供了一个简单的 API，允许用户通过编程方式提取文本的核心句子。API 的调用方式如下：

3.2 API 请求格式

• URL: http://127.0.0.1:8080/api/analyze
• Method: POST
• Content-Type: application/json

3.3 请求参数

• text (string): 需要分析的文本内容。
• output_type (string): 输出类型，可选值为 paragraph（段落形式）或 sentences（句子形式）。
• sentence_count (int): 输出的句子数量，可选值为 10 到 20。

3.4 响应格式

• status (string): 请求状态，成功时为 success，失败时为 error。
• data (array): 提取的核心句子列表。

3.5 示例请求

{
  "text": "这是一个示例文本，用于测试 Bookshrink 的 API 功能。",
  "output_type": "sentences",
  "sentence_count": 2
}

3.6 示例响应

{
  "status": "success",
  "data": [
    "这是一个示例文本，用于测试 Bookshrink 的 API 功能。",
    "Bookshrink 是一个用于提取文本核心句子的工具。"
  ]
}

4. 项目安装方式

4.1 通过 Git 安装

1. 克隆项目代码库：

   git clone https://github.com/peterldowns/bookshrink.git
   

2. 进入项目目录：

   cd bookshrink
   

3. 运行 make 命令进行安装：

   make
   

4.2 通过 Docker 安装（可选）

如果您使用 Docker，可以通过以下步骤安装：

1. 拉取 Docker 镜像：

   docker pull peterldowns/bookshrink
   

2. 运行容器：

   docker run -p 8080:8080 peterldowns/bookshrink
   

3. 打开浏览器，访问 http://127.0.0.1:8080/。

通过以上步骤，您可以顺利安装并使用 Bookshrink 工具，提取文本的核心内容。