cswagerty17/textiply-api

Textiply API 镜像文档

1. 镜像概述

Textiply API 是一个专注于文本处理的轻量级API服务镜像，旨在为开发者提供便捷、高效的文本处理能力。该镜像封装了完整的文本处理服务，支持通过HTTP接口调用各类文本相关功能，可快速部署至容器环境，减少开发与集成成本。

2. 核心功能与特性

2.1 核心功能

• 文本生成：支持基于输入提示生成结构化文本（如摘要、标题、段落等）
• 文本分析：提供关键词提取、情感分析、主题识别等文本解析能力
• 文本转换：支持格式转换（如Markdown转HTML、纯文本格式化）、语言翻译等功能
• 内容过滤：内置敏感词检测与过滤机制，保障文本内容合规性

2.2 特性

• 轻量级：镜像体积小，资源占用低，支持在低配置环境运行
• 易部署：一键启动，无需复杂依赖配置
• 可扩展：支持通过配置文件扩展自定义文本处理规则
• 高可用：内置健康检查机制，支持自动恢复

3. 使用场景与适用范围

3.1 适用场景

• 开发文本处理相关应用（如内容管理系统、智能客服、写作辅助工具）
• 为现有系统集成文本分析能力（如用户评论情感分析、文档自动摘要）
• 构建文本内容过滤与审核服务
• 快速原型验证文本处理算法与逻辑

3.2 适用用户

• 后端开发者（需集成文本处理API的应用开发）
• 数据分析师（需批量处理文本数据的场景）
• 系统集成商（需快速部署文本处理服务的项目）

4. 使用方法与配置说明

4.1 快速启动（Docker Run）

通过以下命令快速启动Textiply API服务：

bash
docker run -d -p 8080:8080 --name textiply-api textiply/api:latest

• -p 8080:8080：映射容器8080端口至主机8080端口（API服务默认端口）
• --name textiply-api：指定容器名称为textiply-api
• textiply/api:latest：使用最新版本镜像

4.2 环境变量配置

可通过环境变量自定义服务配置，常用参数如下：

示例（自定义端口与日志级别）：

bash
docker run -d -p 9000:9000 \
  -e API_PORT=9000 \
  -e LOG_LEVEL=DEBUG \
  --name textiply-api textiply/api:latest

4.3 持久化配置（可选）

如需自定义文本处理规则（如敏感词库、翻译词典），可通过挂载配置目录实现：

bash
docker run -d -p 8080:8080 \
  -v /host/path/config:/app/config \
  --name textiply-api textiply/api:latest

其中/host/path/config为宿主机配置文件目录，需包含rules.json（自定义规则）、dict.txt（词典文件）等。

4.4 API调用示例

服务启动后，可通过HTTP请求调用API，以下为常用接口示例：

4.4.1 文本生成接口

请求：

http
POST http://localhost:8080/api/generate
Content-Type: application/json

{
  "prompt": "生成一段关于环保的宣传语",
  "length": 50
}

响应：

json
{
  "success": true,
  "data": "守护绿水青山，共建美好家园——让环保成为生活习惯，让绿色铺满未来之路。",
  "timestamp": "2024-05-20T10:30:00Z"
}

4.4.2 文本分析接口

请求：

http
POST http://localhost:8080/api/analyze
Content-Type: application/json

{
  "text": "这款产品使用体验非常好，功能强大且操作简单，值得推荐！"
}

响应：

json
{
  "success": true,
  "data": {
    "sentiment": "positive",
    "confidence": 0.92,
    "keywords": ["产品", "使用体验", "功能强大", "操作简单", "推荐"]
  },
  "timestamp": "2024-05-20T10:35:00Z"
}

5. 注意事项

• 服务默认不开启认证，生产环境建议通过反向代理（如Nginx）配置API密钥或OAuth2认证
• 高并发场景下，建议通过docker-compose配置多实例部署并启用负载均衡
• 自定义规则文件需符合JSON格式规范，否则服务启动时可能报错