Apache Unomi 1.x - Documentation

• 语言: 英语
• 格式: .pdf
• 来源: downloads.apache.org

摘要

文档主要介绍了Apache Unomi 1.x的运行和配置方法，包括如何启动服务、使用RESTful API以及处理用户资料和事件。文档还提供了快速入门指南、个人资料读取方法、事件类型定义、个性化推荐实现等内容，并举例说明了如何通过请求与系统交互。此外，文档还介绍了扩展功能，如与外部系统的集成和用户行为分析。

AI总结

# Apache Unomi 1.x 简明文档总结

## 1. 快速运行
- **启动 Karaf**：根据文档中的快速入门指南或构建说明启动 Karaf。
- **初始化完成**：Karaf 控制台显示以下消息表示服务启动成功：

  Initializing user list service endpoint...
  Initializing geonames service endpoint...
  Initializing segment service endpoint...
  ...

- **访问地址**：
- RESTful 服务：`http://localhost:8181/cxs`
- 上下文页面：`http://localhost:8181`

## 2. 快速入门
- **读取个人资料**：通过发送请求到 `/context.json` 端点，需携带请求正文。
- 示例：

  curl -X GET http://localhost:8181/context.json

## 3. 数据模型
### 3.1 个人资料（Profile）
- 通过事件构建用户画像，包含属性、段和评分。

### 3.2 人物（Persona）
- 人物是个人资料的专用版本，用于模拟特定用户群体。
- 示例：

  {
    "itemId": "europeanVisitor",
    "itemType": "persona",
    "properties": {
      "description": "Represents a visitor browsing from Europe",
      "firstName": "European",
      "lastName": "Visitor",
      "continent": "Europe"
    }
  }

### 3.3 范围（Scope）
- 范围是用于分类对象的唯一字符串，常用于区分不同网站或应用。

### 3.4 物品（Item）
- 基础对象，包含标识符和类型，可扩展属性。

### 3.5 事件（Event）
- 事件类型开放，支持自定义。
- 核心字段：
- `eventType`：事件类型标识符。
- `sessionId`：会话唯一标识符。
- `profileId`：个人资料唯一标识符。
- `timestamp`：事件时间（ISO 8601 格式）。
- `source` 和 `target`：事件来源和目标（如按钮、页面）。

## 4. 事件处理
- 事件类型灵活，内置类型如 `view`, `form`, `login` 等。

## 5. 查询与聚合
- 提供强大的查询功能，支持计数、统计（如 sum, max, avg）和复杂聚合。
- 示例：

  curl -X POST http://localhost:8181/cxs -H 'Content-Type: application/json' -d'
  {
    "query": {
      "term": {
        "eventType": "view"
      }
    }
  }'

## 6. 个性化策略
- **过滤器**：实时评估用户条件，如 `filter1` 状态。
- **个性化**：通过 `personalizations` 结构提供多个变体，选择最佳策略。

## 7. 示例集成
### 7.1 登录示例
- **警告**：仅用于示例，实际应从服务器端发送登录事件。
- **安装步骤**：
1. 连接到 Karaf：`ssh -p 8102 karaf@localhost`
2. 安装样本：`bundle:install mvn:org.apache.unomi/login-integration-samples/${project.version}`
3. 启动样本：`bundle:start BUNDLE_ID`
4. 访问页面：`http://localhost:8181/login/index.html`

### 7.2 Twitter 示例
- 使用 Twitter 按钮记录用户 tweeting 次数和来源 URL。
- 通过 JavaScript 调用 Twitter API，发送自定义事件到 Unomi。

---

**总结**：Apache Unomi 1.x 提供了灵活的数据建模、事件处理和个性化功能，适用于用户画像构建、实时分析和个性化推荐。文档中的示例和指南帮助开发者快速上手并集成相关功能。